Type Alias Order

pub type Order = GenericOrder<CARNELIAN_MAX_ORDER>;

Aliased Type

struct Order(/* private fields */);

Implementations

impl<const MAX: usize> GenericOrder<MAX>

pub const MAX: Self

pub const fn as_u32(&self) -> u32

pub const fn new(order: u32) -> Result<Self, OrderError>

pub const fn from_u16(order: u16) -> Self

Create an order from a sixteen bit value that is guaranteed to below the maximum value for an order and thus doesn’t need to be returned as a result and can be used in constant expressions.

Trait Implementations

impl TryFrom<GenericOrder<MAX_ORDER>> for Order

type Error = OrderError

The type returned in the event of a conversion error.

fn try_from(order: SceneOrder) -> Result<Self, OrderError>

Performs the conversion.

impl<const MAX: usize> Clone for GenericOrder<MAX>

fn clone(&self) -> GenericOrder<MAX>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const MAX: usize> Debug for GenericOrder<MAX>

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

Formats the value using the given formatter.

impl<const MAX: usize> Default for GenericOrder<MAX>

fn default() -> GenericOrder<MAX>

Returns the “default value” for a type.

impl<const MAX: usize> Hash for GenericOrder<MAX>

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<const MAX: usize> Ord for GenericOrder<MAX>

fn cmp(&self, other: &GenericOrder<MAX>) -> 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<const MAX: usize> PartialEq for GenericOrder<MAX>

fn eq(&self, other: &GenericOrder<MAX>) -> 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<const MAX: usize> PartialOrd for GenericOrder<MAX>

fn partial_cmp(&self, other: &GenericOrder<MAX>) -> 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<const MAX: usize> TryFrom<u32> for GenericOrder<MAX>

type Error = OrderError

The type returned in the event of a conversion error.

fn try_from(order: u32) -> Result<Self, OrderError>

Performs the conversion.

impl<const MAX: usize> TryFrom<usize> for GenericOrder<MAX>

type Error = OrderError

The type returned in the event of a conversion error.

fn try_from(order: usize) -> Result<Self, OrderError>

Performs the conversion.

impl<const MAX: usize> Copy for GenericOrder<MAX>

impl<const MAX: usize> Eq for GenericOrder<MAX>

impl<const MAX: usize> StructuralPartialEq for GenericOrder<MAX>