Struct TwoDaName 

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

A validated 2DA table name (e.g. racialtypes, appearance).

Wraps ResRef so cache keys are distinguishable from arbitrary resrefs at the type level. Layers an ASCII-only check on top of ResRef’s broader Windows-1252 acceptance: vanilla K1 2DA names are pure ASCII, and chitin.key’s filename table is ASCII-only, so an extended-character 2DA name would not resolve anyway.

The name does not include the .2da extension – the ResourceTypeCode supplies that at resolver lookup time.

Implementations

impl TwoDaName

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

Creates a 2DA name from a string.

2DA filenames are conventionally ASCII; this constructor enforces that invariant on top of ResRef’s broader Windows-1252 acceptance, since extended-character 2DA names would not round-trip through chitin.key’s ASCII-only filename table anyway.

pub fn as_resref(&self) -> &ResRef

Returns a reference to the underlying ResRef for resolver lookups that take &ResRef directly.

pub fn as_str(&self) -> &str

Returns the canonical lowercase string form of the name, suitable for passing to TwoDaCache::twoda without an extra round trip through TwoDaName::new.

TwoDaName enforces an ASCII-only invariant on construction (2DA filenames are conventionally ASCII), so this can return a borrowed &str directly.

pub const fn from_static(name: &'static str) -> Self

const-friendly constructor for pub const table-name declarations.

Validation runs at compile time via ResRef::const_new; an invalid input panics during compilation rather than at first use. Mirrors http::HeaderName::from_static. Use this only for hardcoded vanilla / known table names whose validity you can verify by inspection – runtime-discovered names should go through Self::new instead.

Trait Implementations

impl AsRef<ResRef> for TwoDaName

fn as_ref(&self) -> &ResRef

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

impl AsRef<str> for TwoDaName

fn as_ref(&self) -> &str

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

impl Clone for TwoDaName

fn clone(&self) -> TwoDaName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TwoDaName

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

Formats the value using the given formatter.

impl Display for TwoDaName

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

Formats the value using the given formatter.

impl Hash for TwoDaName

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 TwoDaName

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

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

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

impl Eq for TwoDaName

impl StructuralPartialEq for TwoDaName