Struct OptionRangedU64 

pub struct OptionRangedU64<const MIN: u64, const MAX: u64>(/* private fields */);

An optional RangedU64; similar to Option<RangedU64> with better optimization.

If MIN is u64::MIN and MAX is u64::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 OptionRangedU64::get.

Implementations

impl<const MIN: u64, const MAX: u64> OptionRangedU64<MIN, MAX>

pub const None: Self

An optional ranged value that is not present.

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

Creates an optional ranged value that is present.

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

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

pub const unsafe fn some_unchecked(value: u64) -> 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.

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

Obtain the value of the struct as an Option of the primitive type.

A call to this function will output a hint to the compiler that the value is in range. In general this will help the optimizer to generate better code, but in edge cases this may lead to worse code generation. To avoid outputting the hint, you can use OptionRangedU64::get_primitive_without_hint.

pub const fn get_primitive_without_hint(self) -> Option<u64>

Obtain the value of the struct as an Option of the primitive type.

The returned value is identical to OptionRangedU64::get_primitive. Unlike get_primitive, no hints are output to the compiler indicating the range that the value is in. Depending on the scenario, this may with be helpful or harmful too optimization.

pub const fn is_none(&self) -> bool

Returns true if the value is the niche value.

pub const fn is_some(&self) -> bool

Returns true if the value is not the niche value.

Trait Implementations

impl<const MIN: u64, const MAX: u64> Arbitrary for OptionRangedU64<MIN, MAX>

Available on crate feature quickcheck only.

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl<const MIN: u64, const MAX: u64> Clone for OptionRangedU64<MIN, MAX>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MIN: u64, const MAX: u64> Debug for OptionRangedU64<MIN, MAX>

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

Formats the value using the given formatter.

impl<const MIN: u64, const MAX: u64> Default for OptionRangedU64<MIN, MAX>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const MIN: u64, const MAX: u64> Deserialize<'de> for OptionRangedU64<MIN, MAX>

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

#[doc(hidden)] fn deserialize_in_place<D>( deserializer: D, place: &mut Self, ) -> Result<(), <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes a value into self from the given Deserializer.

impl<const MIN: u64, const MAX: u64> Distribution<OptionRangedU64<MIN, MAX>> for Standard

Available on crate feature rand08 only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> OptionRangedU64<MIN, MAX>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<const MIN: u64, const MAX: u64> Eq for OptionRangedU64<MIN, MAX>

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

impl<const MIN: u64, const MAX: u64> From<Option<RangedU64<MIN, MAX>>> for OptionRangedU64<MIN, MAX>

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

Converts to this type from the input type.

impl<const MIN: u64, const MAX: u64> From<OptionRangedU64<MIN, MAX>> for Option<RangedU64<MIN, MAX>>

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

Converts to this type from the input type.

impl<const MIN: u64, const MAX: u64> From<RangedU64<MIN, MAX>> for OptionRangedU64<MIN, MAX>

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

Converts to this type from the input type.

impl<const MIN: u64, const MAX: u64> Hash for OptionRangedU64<MIN, 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 MIN: u64, const MAX: u64> Ord for OptionRangedU64<MIN, MAX>

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<const MIN_A: u64, const MAX_A: u64, const MIN_B: u64, const MAX_B: u64> PartialEq<OptionRangedU64<MIN_B, MAX_B>> for OptionRangedU64<MIN_A, MAX_A>

fn eq(&self, other: &OptionRangedU64<MIN_B, MAX_B>) -> 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 MIN_A: u64, const MAX_A: u64, const MIN_B: u64, const MAX_B: u64> PartialOrd<OptionRangedU64<MIN_B, MAX_B>> for OptionRangedU64<MIN_A, MAX_A>

fn partial_cmp(&self, other: &OptionRangedU64<MIN_B, MAX_B>) -> 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.

#[doc(hidden)] fn __chaining_lt(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

If self == other, returns ControlFlow::Continue(()). Otherwise, returns ControlFlow::Break(self < other).

#[doc(hidden)] fn __chaining_le(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for <= instead of <.

#[doc(hidden)] fn __chaining_gt(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for > instead of <.

#[doc(hidden)] fn __chaining_ge(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for >= instead of <.

impl<const MIN: u64, const MAX: u64> Serialize for OptionRangedU64<MIN, MAX>

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl<const MIN: u64, const MAX: u64> Copy for OptionRangedU64<MIN, MAX>