Struct ResRef 

pub struct ResRef { /* private fields */ }

Canonicalized resource reference.

KotOR resource references are case-insensitive identifiers with a maximum length of 16 characters. This type stores the lowercase canonical form as an inline fixed-size buffer, making it Copy and zero-allocation.

The valid character set is ASCII alphanumerics, underscore, and hyphen ([A-Za-z0-9_-]). Hyphens appear in stock KotOR content (for example t3-m4, hk-47), so they are accepted by validation.

Implementations

impl ResRef

pub fn new(value: impl AsRef<str>) -> Result<Self, ResRefError>

Creates and validates a new resource reference.

Accepted characters are ASCII alphanumerics, underscore, and hyphen. The input is canonicalized to lowercase. An empty string produces a blank ResRef.

pub const fn blank() -> Self

Returns an empty resource reference.

pub fn as_str(&self) -> &str

Returns the canonical lowercase string representation.

pub const fn is_blank(&self) -> bool

Returns true when the resource reference is empty.

pub const fn is_empty(&self) -> bool

Returns true when the resource reference is empty.

Alias for is_blank matching the standard collection API.

pub const fn len(&self) -> usize

Returns the length in bytes (equals character count since all content is ASCII).

Trait Implementations

impl AsRef<str> for ResRef

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ResRef

fn clone(&self) -> ResRef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ResRef

fn default() -> Self

Returns the “default value” for a type.

impl Display for ResRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ResRef> for String

fn from(val: ResRef) -> Self

Converts to this type from the input type.

impl FromStr for ResRef

type Err = ResRefError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ResRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ResRef

fn cmp(&self, other: &ResRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&str> for ResRef

fn eq(&self, other: &&str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for ResRef

fn eq(&self, other: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ResRef

fn eq(&self, other: &ResRef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ResRef

fn partial_cmp(&self, other: &ResRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for ResRef

type Error = ResRefError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for ResRef

type Error = ResRefError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ResRef

impl Eq for ResRef

impl StructuralPartialEq for ResRef