Struct deranged::OptionRangedU8

source ·
pub struct OptionRangedU8<const MIN: u8, const MAX: u8>(/* private fields */);
Expand description

A RangedU8 that is optional. Equivalent to Option<RangedU8> with niche value optimization.

If MIN is u8::MIN and MAX is u8::MAX then compilation will fail. This is because there is no way to represent the niche value.

This type is useful when you need to store an optional ranged value in a struct, but do not want the overhead of an Option type. This reduces the size of the struct overall, and is particularly useful when you have a large number of optional fields. Note that most operations must still be performed on the Option type, which is obtained with OptionRangedU8::get.

Implementations§

source§

impl<const MIN: u8, const MAX: u8> OptionRangedU8<MIN, MAX>

source

pub const None: Self = _

An optional ranged value that is not present.

source

pub const fn Some(value: RangedU8<MIN, MAX>) -> Self

Creates an optional ranged value that is present.

source

pub const fn get(self) -> Option<RangedU8<MIN, MAX>>

Returns the value as the standard library’s Option type.

source

pub const unsafe fn some_unchecked(value: u8) -> Self

Creates an optional ranged integer without checking the value.

§Safety

The value must be within the range MIN..=MAX. As the value used for niche value optimization is unspecified, the provided value must not be the niche value.

source

pub const fn get_primitive(self) -> Option<u8>

source

pub const fn is_none(self) -> bool

Returns true if the value is the niche value.

source

pub const fn is_some(self) -> bool

Returns true if the value is not the niche value.

Trait Implementations§

source§

impl<const MIN: u8, const MAX: u8> Clone for OptionRangedU8<MIN, MAX>

source§

fn clone(&self) -> OptionRangedU8<MIN, MAX>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<const MIN: u8, const MAX: u8> Debug for OptionRangedU8<MIN, MAX>

source§

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

Formats the value using the given formatter. Read more
source§

impl<const MIN: u8, const MAX: u8> Default for OptionRangedU8<MIN, MAX>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<const MIN: u8, const MAX: u8> From<Option<RangedU8<MIN, MAX>>> for OptionRangedU8<MIN, MAX>

source§

fn from(value: Option<RangedU8<MIN, MAX>>) -> Self

Converts to this type from the input type.
source§

impl<const MIN: u8, const MAX: u8> From<OptionRangedU8<MIN, MAX>> for Option<RangedU8<MIN, MAX>>

source§

fn from(value: OptionRangedU8<MIN, MAX>) -> Self

Converts to this type from the input type.
source§

impl<const MIN: u8, const MAX: u8> From<RangedU8<MIN, MAX>> for OptionRangedU8<MIN, MAX>

source§

fn from(value: RangedU8<MIN, MAX>) -> Self

Converts to this type from the input type.
source§

impl<const MIN: u8, const MAX: u8> Hash for OptionRangedU8<MIN, MAX>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<const MIN: u8, const MAX: u8> Ord for OptionRangedU8<MIN, MAX>

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<const MIN_A: u8, const MAX_A: u8, const MIN_B: u8, const MAX_B: u8> PartialEq<OptionRangedU8<MIN_B, MAX_B>> for OptionRangedU8<MIN_A, MAX_A>

source§

fn eq(&self, other: &OptionRangedU8<MIN_B, MAX_B>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<const MIN_A: u8, const MAX_A: u8, const MIN_B: u8, const MAX_B: u8> PartialOrd<OptionRangedU8<MIN_B, MAX_B>> for OptionRangedU8<MIN_A, MAX_A>

source§

fn partial_cmp(&self, other: &OptionRangedU8<MIN_B, MAX_B>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<const MIN: u8, const MAX: u8> Copy for OptionRangedU8<MIN, MAX>

source§

impl<const MIN: u8, const MAX: u8> Eq for OptionRangedU8<MIN, MAX>

Auto Trait Implementations§

§

impl<const MIN: u8, const MAX: u8> Freeze for OptionRangedU8<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> RefUnwindSafe for OptionRangedU8<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> Send for OptionRangedU8<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> Sync for OptionRangedU8<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> Unpin for OptionRangedU8<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> UnwindSafe for OptionRangedU8<MIN, MAX>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.