Struct Index 

pub struct Index<T> { /* private fields */ }

A branded index into a typed collection.

The phantom type T prevents mixing indices of different domains (e.g. you cannot use a CharShapeIndex where a ParaShapeIndex is expected).

Serializes as a plain usize, not as a struct.

Examples

use hwpforge_foundation::{CharShapeIndex, ParaShapeIndex};

let cs = CharShapeIndex::new(5);
let ps = ParaShapeIndex::new(5);

// cs and ps have the same numeric value but are different types.
assert_eq!(cs.get(), ps.get());
// cs == ps; // Would not compile -- different phantom types!

Implementations

impl<T> Index<T>

pub const fn new(value: usize) -> Self

Creates a new index with the given value.

No bounds checking is performed here; use checked_get when accessing a collection.

pub const fn get(self) -> usize

Returns the raw usize value.

Note

The caller is responsible for ensuring this index is within the bounds of the target collection. Prefer checked_get for safe access.

pub fn checked_get(self, max: usize) -> FoundationResult<usize>

Returns the raw value after verifying it is less than max.

Errors

Returns FoundationError::IndexOutOfBounds when self.value >= max.

Examples

use hwpforge_foundation::FontIndex;

let idx = FontIndex::new(3);
assert_eq!(idx.checked_get(10).unwrap(), 3);
assert!(idx.checked_get(2).is_err());

Trait Implementations

impl<T> Clone for Index<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Index<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Index<T>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T> Display for Index<T>

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

Formats the value using the given formatter.

impl<T> Hash for Index<T>

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<T> JsonSchema for Index<T>

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl<T> Ord for Index<T>

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<T> PartialEq for Index<T>

fn eq(&self, other: &Self) -> 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<T> PartialOrd for Index<T>

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<T> Serialize for Index<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T> Copy for Index<T>

impl<T> Eq for Index<T>