Struct FaceId 

pub struct FaceId { /* private fields */ }

Implementations

impl FaceId

pub const MAX_INDEX: usize

If Self::CHECKS_MAX_INDEX is true, we’ll assert if trying to produce a value larger than this in any of the ctors that don’t have unchecked in their name.

pub const CHECKS_MAX_INDEX: bool

Does this index type assert if asked to construct an index larger than MAX_INDEX?

pub fn new(value: usize) -> Self

Construct this index type from a usize. Alias for from_usize.

pub fn from_raw(value: RawFaceId) -> Self

Construct this index type from the wrapped integer type.

pub fn from_foreign<F: Idx>(value: F) -> Self

Construct this index type from one in a different domain

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

Construct from a usize without any checks.

pub const fn from_raw_unchecked(raw: RawFaceId) -> Self

Construct from the underlying type without any checks.

pub fn from_usize(value: usize) -> Self

Construct this index type from a usize.

pub const fn index(self) -> usize

Get the wrapped index as a usize.

pub const fn raw(self) -> RawFaceId

Get the wrapped index.

pub fn check_index(v: usize)

Asserts v <= Self::MAX_INDEX unless Self::CHECKS_MAX_INDEX is false.

Trait Implementations

impl Add<FaceId> for usize

type Output = FaceId

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for FaceId

type Output = FaceId

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for FaceId

type Output = FaceId

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for FaceId

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl AddAssign for FaceId

fn add_assign(&mut self, other: FaceId)

Performs the += operation.

impl Clone for FaceId

fn clone(&self) -> FaceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstDefault for FaceId

where RawFaceId: ConstDefault,

const DEFAULT: Self

The constant default value.

impl Debug for FaceId

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

Formats the value using the given formatter.

impl Default for FaceId

fn default() -> FaceId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FaceId

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

Deserialize this value from the given Serde deserializer.

impl From<FaceId> for RawFaceId

fn from(v: FaceId) -> RawFaceId

Converts to this type from the input type.

impl From<FaceId> for usize

fn from(v: FaceId) -> usize

Converts to this type from the input type.

impl From<u8> for FaceId

fn from(value: RawFaceId) -> Self

Converts to this type from the input type.

impl From<usize> for FaceId

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for FaceId

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

fn from_usize(value: usize) -> Self

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

fn index(self) -> usize

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

impl Ord for FaceId

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

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

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 PartialEq for FaceId

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

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

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 PartialOrd for FaceId

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

type Output = FaceId

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for FaceId

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

Serialize this value into the given Serde serializer.

impl Sub<FaceId> for usize

type Output = FaceId

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for FaceId

type Output = FaceId

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for FaceId

type Output = FaceId

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for FaceId

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl SubAssign for FaceId

fn sub_assign(&mut self, other: FaceId)

Performs the -= operation.

impl Copy for FaceId

impl Eq for FaceId

impl StructuralPartialEq for FaceId