Struct StrRef 

pub struct StrRef(/* private fields */);

TLK string-reference wrapper shared across KotOR formats.

Most formats store string references as signed 32-bit integers where -1 means “unset/no string”.

Implementations

impl StrRef

pub const fn from_raw(raw: i32) -> Self

Creates a string reference from a raw on-disk value.

pub const fn invalid() -> Self

Returns the canonical “unset” string-reference value (-1).

pub fn from_index(index: u32) -> Result<Self, StrRefError>

Creates a string reference from a non-negative TLK index.

pub const fn raw(self) -> i32

Returns the raw on-disk value.

pub const fn is_invalid(self) -> bool

Returns true if this value is the unset sentinel (-1).

pub const fn is_valid(self) -> bool

Returns true for non-negative TLK indexes.

pub fn index(self) -> Option<u32>

Returns this value as a TLK index when it is non-negative.

Trait Implementations

impl Clone for StrRef

fn clone(&self) -> StrRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StrRef

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

Formats the value using the given formatter.

impl Default for StrRef

fn default() -> Self

Returns the “default value” for a type.

impl Display for StrRef

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

Formats the value using the given formatter.

impl From<StrRef> for i32

fn from(value: StrRef) -> Self

Converts to this type from the input type.

impl From<i32> for StrRef

fn from(value: i32) -> Self

Converts to this type from the input type.

impl Hash for StrRef

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 StrRef

fn cmp(&self, other: &StrRef) -> 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 for StrRef

fn eq(&self, other: &StrRef) -> 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 StrRef

fn partial_cmp(&self, other: &StrRef) -> 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<u32> for StrRef

type Error = StrRefError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for StrRef

impl Eq for StrRef

impl StructuralPartialEq for StrRef