Struct Label 

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

A label identifier.

Implementations

impl Label

pub const MAX_INDEX: usize

The maximum representable index value.

pub const CHECKS_MAX_INDEX: bool = true

Whether this index type performs bounds checking.

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

Create a new index from a usize value.

Panics

Panics if value > MAX_INDEX.

pub const fn from_raw(value: NonMaxU32) -> Label

Create an index from a raw NonMaxU32 value.

pub fn from_foreign<F>(value: F) -> Label

where F: Idx,

Convert an index from another index type.

pub const unsafe fn from_usize_unchecked(value: usize) -> Label

Create an index from a usize without bounds checking.

SAFETY

The caller must ensure value < (u32::MAX as usize).

pub const unsafe fn from_raw_unchecked(raw: u32) -> Label

Create an index from a raw u32 without bounds checking.

SAFETY

The caller must ensure the value is not u32::MAX.

pub const fn from_usize(value: usize) -> Label

Create an index from a usize with bounds checking.

Panics

Panics if value > MAX_INDEX.

pub const fn index(self) -> usize

Get the index value as a usize.

pub const fn raw(self) -> NonMaxU32

Get the raw NonMaxU32 value.

impl Label

pub const MAX: Label

The maximum index value.

Trait Implementations

impl Add for Label

type Output = Label

The resulting type after applying the + operator.

fn add(self, other: Label) -> Label

Performs the + operation.

impl Add<usize> for Label

type Output = Label

The resulting type after applying the + operator.

fn add(self, other: usize) -> Label

Performs the + operation.

impl AddAssign for Label

fn add_assign(&mut self, other: Label)

Performs the += operation.

impl AddAssign<usize> for Label

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Label

impl Debug for Label

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

Formats the value using the given formatter.

impl Eq for Label

impl From<usize> for Label

fn from(value: usize) -> Label

Converts to this type from the input type.

impl Hash for Label

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Idx for Label

const MAX: usize = Self::MAX_INDEX

The maximum value that can be represented by this index type.

unsafe fn from_usize_unchecked(idx: usize) -> Label

Construct an index from a usize without bounds checking.

fn index(self) -> usize

Get the underlying index. This is equivalent to Into<usize>

fn from_usize(idx: usize) -> Self

Construct an Index from a usize. This is equivalent to From<usize>.

impl Ord for Label

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

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

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

fn partial_cmp(&self, other: &Label) -> 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 PartialOrd<usize> for Label

fn partial_cmp(&self, other: &usize) -> 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 Rem<usize> for Label

type Output = Label

The resulting type after applying the % operator.

fn rem(self, other: usize) -> Label

Performs the % operation.

impl StructuralPartialEq for Label

impl Sub for Label

type Output = Label

The resulting type after applying the - operator.

fn sub(self, other: Label) -> Label

Performs the - operation.

impl Sub<usize> for Label

type Output = Label

The resulting type after applying the - operator.

fn sub(self, other: usize) -> Label

Performs the - operation.

impl SubAssign for Label

fn sub_assign(&mut self, other: Label)

Performs the -= operation.

impl SubAssign<usize> for Label

fn sub_assign(&mut self, other: usize)

Performs the -= operation.