Struct numid::example::NumId

pub struct NumId(_);

A numerical id generated with the numid! macro. This struct example is generated with the macro call : numid!(#[doc=…] pub struct NumId);.

Methods

impl NumId

pub const INITIAL_VALUE: u64

Constant defined when calling the numid! macro (0 if not defined). The firt id created (with new() or default()) will have value = INITIAL_VALUE + 1.

pub fn new() -> NumId

Increment the "current value" and create a new id with value = current_value().

pub const fn value(self) -> u64

Get the value of the id.

pub fn current_value() -> u64

Return the "current value", the value of the last id created (with new(), default() or create_maybe()), if no id has been created, the "current value" equal initial_value().

pub const fn initial_value() -> u64

Return INITIAL_VALUE.

pub fn replace_current_value(value: u64) -> bool

Replace the "current value" by the value parameter if it superior. This condition is necessary for not creating multiple ids with the same value. Return true if the "current value" has been modified.

pub fn create_maybe(value: u64) -> Option<NumId>

Return Some id with specified value and replace the "current value" if replace_current_value(value) is true. Return None otherwise.

pub fn create_lower(value: u64) -> NumId

Create a id with a precised value, don't increment the "current value". The value must be inferior or equal as INITIAL_VALUE for not interfering with the id system.

Panics

panic if value > INITIAL_VALUE

pub const fn const_create_lower(value: u64) -> NumId

Const version of create_lower, can be used in a const environnement. In a non-const environnement, give a index: out of bounds panic message, create_lower giving a more descriptive message is therefore preferred.

Panics

panic if value > INITIAL_VALUE

pub fn reproduce(self) -> NumId

Return a copy of the id if the value is inferior or equal as initial_value, else return a new id and update the current_value.

Trait Implementations

impl Display for NumId

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

Formats the value using the given formatter.

impl Debug for NumId

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

Formats the value using the given formatter.

impl PartialEq<NumId> for NumId

fn eq(&self, other: &NumId) -> bool

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

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

This method tests for !=.

impl Eq for NumId

impl Ord for NumId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialOrd<NumId> for NumId

fn partial_cmp(&self, other: &NumId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Hash for NumId

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, 

Feeds a slice of this type into the given [Hasher].

impl Copy for NumId

impl StructuralPartialEq for NumId

impl StructuralEq for NumId

impl Octal for NumId

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

Formats the value using the given formatter.

impl Binary for NumId

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

Formats the value using the given formatter.

impl LowerHex for NumId

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

Formats the value using the given formatter.

impl UpperHex for NumId

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

Formats the value using the given formatter.

impl Clone for NumId

fn clone(&self) -> NumId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for NumId

Increment the "current value" and create a new id with value = current_value(). This is equivalent to new().

fn default() -> NumId

Returns the "default value" for a type.