Struct IndexName 

pub struct IndexName { /* private fields */ }

Validated index identity with fixed-size persisted representation.

Used by index-store key domains as canonical index-name bytes.

Implementations

impl IndexName

pub const STORED_SIZE_BYTES: u64

Fixed on-disk size in bytes (stable, protocol-level).

pub const STORED_SIZE_USIZE: usize

Fixed in-memory size (for buffers and arrays).

pub fn try_from_entity_fields( entity: &EntityName, fields: &[&str], ) -> Result<Self, IndexNameError>

Validate and construct one non-unique index identity from an entity + field list.

pub fn try_unique_from_entity_fields( entity: &EntityName, fields: &[&str], ) -> Result<Self, IndexNameError>

Validate and construct one unique index identity from an entity + field list.

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

Borrow raw index-identity bytes excluding trailing fixed-buffer padding.

pub fn as_str(&self) -> &str

Borrow the index identity as UTF-8 text.

Panics

Panics if the stored index-name bytes violate the ASCII-only identity invariant. Construction and decoding are expected to prevent this.

pub fn to_bytes(self) -> [u8; 492]

Encode this identity into its fixed-size persisted representation.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, IdentityDecodeError>

Decode one fixed-size persisted index identity payload.

This validates the canonical fixed-width byte envelope only. It does not reconstruct field segments or prove the bytes were produced by try_from_entity_fields; callers must ensure persisted bytes originate from a previously validated IndexName.

Trait Implementations

impl Clone for IndexName

fn clone(&self) -> IndexName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IndexName

impl Debug for IndexName

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

Formats the value using the given formatter.

impl Display for IndexName

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

Formats the value using the given formatter.

impl Eq for IndexName

impl Hash for IndexName

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 IndexName

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

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

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for IndexName