Struct nominals::DigitSet

pub struct DigitSet<const N: usize, const HAS_ZERO: bool> { /* private fields */ }

An ordered set of characters that can be treated as digits.

Const Generics

• N: The number of digits in this set.
• HAS_ZERO: When true, the first digit in the set represents 0.

  • For Decimal, HAS_ZERO is true. This produces the ordering when counting from zero goes:

    n	0	1	2	…	9	10	11	12	…
    nominal	0	1	2	…	9	10	11	12	…

  • For LetterUpper, if A were treated as a 0, the first symbol that would appear in the “tens” location would be B:

    n	0	1	2	…	25	26	27	28	…
    nominal	A	B	C	…	Z	BA	BB	BC	…

    This is not the expected behavior, so LetterUpper utilizes DigitSet::zeroless to create a set with HAS_ZERO set to false. This produces the order:

    n	0	1	2	…	25	26	27	28	…
    nominal	A	B	C	…	Z	AA	AB	AC	…

    If 1-based counting is desired, DigitSet::one_based returns an updated set that returns Error::NoZeroSymbol if asked to format 0. It produces this order:

    n	0	1	2	3	…	26	27	28	29	…
    nominal	err	A	B	C	…	Z	AA	AB	AC	…

Implementations

impl<const N: usize> DigitSet<N, true>

pub const fn new(digits: [char; N]) -> Self

Returns a digit set whose first digit represents the 0 digit.

impl<const N: usize> DigitSet<N, false>

pub const fn zeroless(digits: [char; N]) -> Self

Returns a digit set that does not have a symbol representing a 0 digit.

Trait Implementations

impl<const N: usize> DigitCollection for DigitSet<N, false>

type Fallback = NoFallback

The digit collection that should be used after this collection’s range is exhausted.

fn has_zero_digit(&self) -> bool

Returns true if this collection has a symbol representing 0 at index 0.

fn len(&self) -> usize

Returns the number of digits in this collection.

fn digit(&self, index: usize) -> char

Returns the digit at location index.

fn fixed(&self) -> bool

If true, this digit collection can only produce a single digit.

fn zero_based(&self) -> bool

Returns true if this collection should start counting at 1 instead of 0. This function is only called if has_zero_digit() returns false.

fn is_empty(&self) -> bool

Returns true if this collection’s length is 0.

fn and<Other>(self, other: Other) -> Chain<Self, Other>

where Self: Sized, Other: DigitCollection,

Chains self and other into a single DigitCollection.

fn one_based(self) -> OneBased<Self>

where Self: Sized,

Returns this collection that indicates counting should start at 1 instead of 0.

impl<const N: usize> DigitCollection for DigitSet<N, true>

type Fallback = NoFallback

The digit collection that should be used after this collection’s range is exhausted.

fn has_zero_digit(&self) -> bool

Returns true if this collection has a symbol representing 0 at index 0.

fn len(&self) -> usize

Returns the number of digits in this collection.

fn digit(&self, index: usize) -> char

Returns the digit at location index.

fn fixed(&self) -> bool

If true, this digit collection can only produce a single digit.

fn zero_based(&self) -> bool

Returns true if this collection should start counting at 1 instead of 0. This function is only called if has_zero_digit() returns false.

fn is_empty(&self) -> bool

Returns true if this collection’s length is 0.

fn and<Other>(self, other: Other) -> Chain<Self, Other>

where Self: Sized, Other: DigitCollection,

Chains self and other into a single DigitCollection.

fn one_based(self) -> OneBased<Self>

where Self: Sized,

Returns this collection that indicates counting should start at 1 instead of 0.