Struct ResRef 

pub struct ResRef { /* private fields */ }

Canonicalized resource reference.

KotOR resource references are case-insensitive identifiers up to 16 bytes long, stored as Windows-1252-encoded bytes (the engine’s native encoding). This type holds the bytes in an inline fixed-size buffer, making it Copy and zero-allocation.

Validation rules

Accepts any input that round-trips through Windows-1252 encoding. ASCII bytes pass straight through; non-ASCII chars that have a Windows-1252 representation (é, ü, £, etc.) get transcoded to their single-byte Windows-1252 form. Characters with no Windows-1252 mapping (Chinese, emoji, etc.) are rejected.

The engine itself performs no character validation at all (verbatim memcpy into a 16-byte buffer). Validation here exists to ensure we only construct resrefs that can actually be stored in the engine-native encoding. For the full engine audit, see the ResRef Validation section of docs/src/formats/resource_system.md.

Storage and access

Use Self::as_bytes for byte-level work (writing to disk, hashing, lint inspection, byte-level comparison). For a string view, use the Display impl (e.g. format!("{resref}") or resref.to_string()); it decodes Windows-1252 → UTF-8 on demand.

Implementations

impl ResRef

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

Creates and validates a new resource reference.

The input is transcoded from UTF-8 to Windows-1252 (the engine’s native encoding); ASCII letters are lowercased for the engine’s case-insensitive lookup. Returns ResRefError::InvalidChar when a character has no Windows-1252 mapping (Chinese, emoji, etc.) and ResRefError::TooLong when the encoded form exceeds 16 bytes. An empty string produces a blank ResRef.

pub const fn const_new(value: &str) -> Result<Self, ResRefError>

const-friendly version of Self::new for declaring pub const resref constants at compile time.

Restricted to ASCII-only input (Windows-1252 transcoding is not const-friendly). Use Self::new for runtime input that may contain extended Windows-1252 characters.

pub const fn blank() -> Self

Returns an empty resource reference.

pub fn as_bytes(&self) -> &[u8]

Returns the canonical Windows-1252 bytes that make up this resref.

This is the engine-actual storage form. Use this for byte-level work (writing to disk, hashing, lint inspection of byte patterns, comparing against a byte-string literal).

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 Windows-1252 bytes.

For ASCII-only resrefs (the overwhelming majority) this equals the character count. For extended-character resrefs it is the engine-storage byte count, not the UTF-8 byte count of the Display form.

Trait Implementations

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<&[u8]> for ResRef

fn eq(&self, other: &&[u8]) -> 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<[u8]> for ResRef

fn eq(&self, other: &[u8]) -> 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<ResRef> for &str

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 PartialEq<ResRef> for str

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 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