Struct digit_sequence::DigitSequence

pub struct DigitSequence(/* private fields */);

Immutable sequence of u8 digits.

Creation

A digit sequence is usually created via conversions - which are not always infallible; a constructor is also provided to instantiate an empty sequence.

Infallible conversions

• from any unsigned number:

  use digit_sequence::{CrateResult, DigitSequence};
  
  let sequence: DigitSequence = 985u32.into();
  
  assert_eq!(sequence, [9, 8, 5]);

Fallible conversions

• from any signed number - which fails if the number is negative:

  use digit_sequence::{CrateResult, DigitSequence};
  
  let sequence: DigitSequence = 3791i32.try_into()?;
  
  assert_eq!(sequence, [3, 7, 9, 1]);

• from &str - which fails in case of non-digit (radix 10) characters:

  use digit_sequence::{CrateResult, DigitSequence};
  
  let sequence: DigitSequence = "09240".parse()?;
  
  assert_eq!(sequence, [0, 9, 2, 4, 0]);

• from a &[u8] - which fails if the numbers are not 0-9 digits:

  use digit_sequence::{CrateResult, DigitSequence};
  
  let source = [0, 9, 2, 4, 0];
  let sequence: DigitSequence = (&source).try_into()?;
  
  assert_eq!(sequence, source);

• to any unsigned number - which can fail with CrateError::Overflow:

  use digit_sequence::{CrateResult, CrateError, DigitSequence};
  
  let in_range_sequence: DigitSequence = "90".parse()?;
  let number: u128 = in_range_sequence.try_into()?;
  assert_eq!(number, 90);
  
  let overflowing_sequence: DigitSequence = "1".repeat(100).parse()?;
  let result: CrateResult<u128> = overflowing_sequence.try_into();
  assert_eq!(result, Err(CrateError::Overflow));
  

  Conversion from &DigitSequence is also supported:

  use digit_sequence::{CrateResult, CrateError, DigitSequence};
  
  let sequence: DigitSequence = "90".parse()?;
  let reference = &sequence;  
  let number: u128 = reference.try_into()?;
  assert_eq!(number, 90);
  

Usage

This data structure implements IntoIterator and also provides the iter method - thus enabling standard iterations as well as the Iterator methods.

for-iterations

read-only

use digit_sequence::DigitSequence;

let sequence: DigitSequence = 1234567890u128.into();
   
let mut even_vec = vec![];

for &digit in &sequence {
  if digit % 2 == 0 {
    even_vec.push(digit);
  }
}

assert_eq!(even_vec, vec![2, 4, 6, 8, 0]);

consuming

use digit_sequence::DigitSequence;

let sequence: DigitSequence = 1234567890u128.into();
   
let mut even_vec = vec![];

for digit in sequence {
  if digit % 2 == 0 {
    even_vec.push(digit);
  }
}

assert_eq!(even_vec, vec![2, 4, 6, 8, 0]);

Iterator methods

read-only

use digit_sequence::DigitSequence;

let sequence: DigitSequence = 1234567890u128.into();

let even_vec: Vec<u8> = sequence.iter()
  .filter(|&digit| digit % 2 == 0)
  .map(|&digit|digit)
  .collect();

assert_eq!(even_vec, vec![2, 4, 6, 8, 0]);

consuming

use digit_sequence::DigitSequence;

let sequence: DigitSequence = 1234567890u128.into();

let even_vec: Vec<u8> = sequence.into_iter()
  .filter(|digit| digit % 2 == 0)
  .collect();

assert_eq!(even_vec, vec![2, 4, 6, 8, 0]);

Conversion to String

• the Debug trait is derived

• for the Display trait, the sequence is formatted just by joining its digits

Serialization

When the serde feature is enabled for this crate, Self implements the serde::Serialize and serde::Deserialize traits.

Implementations

impl DigitSequence

pub fn new() -> DigitSequence

Creates an empty DigitSequence

use digit_sequence::DigitSequence;

let sequence = DigitSequence::new();

assert_eq!(sequence.iter().len(), 0);

pub fn iter(&self) -> Iter<'_, u8>

Convenience method for iterating over references to the digits.

pub fn is_empty(&self) -> bool

Tells whether the sequence is empty.

use digit_sequence::*;

let empty_sequence = DigitSequence::new();
assert!(empty_sequence.is_empty());

let non_empty_sequence: DigitSequence = 84u8.into();
assert!(!non_empty_sequence.is_empty());

Trait Implementations

impl Clone for DigitSequence

fn clone(&self) -> DigitSequence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DigitSequence

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

Formats the value using the given formatter.

impl Default for DigitSequence

fn default() -> DigitSequence

Returns the “default value” for a type.

impl Display for DigitSequence

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

Formats the value using the given formatter.

impl From<u128> for DigitSequence

fn from(value: u128) -> DigitSequence

Converts to this type from the input type.

impl From<u16> for DigitSequence

fn from(value: u16) -> DigitSequence

Converts to this type from the input type.

impl From<u32> for DigitSequence

fn from(value: u32) -> DigitSequence

Converts to this type from the input type.

impl From<u64> for DigitSequence

fn from(value: u64) -> DigitSequence

Converts to this type from the input type.

impl From<u8> for DigitSequence

fn from(value: u8) -> DigitSequence

Converts to this type from the input type.

impl From<usize> for DigitSequence

fn from(value: usize) -> DigitSequence

Converts to this type from the input type.

impl FromStr for DigitSequence

type Err = CrateError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> CrateResult<Self>

Parses a string s to return a value of this type.

impl Hash for DigitSequence

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<'a> IntoIterator for &'a DigitSequence

type Item = &'a u8

The type of the elements being iterated over.

type IntoIter = Iter<'a, u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for DigitSequence

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<<DigitSequence as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for DigitSequence

fn cmp(&self, other: &DigitSequence) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&[u8]> for DigitSequence

fn eq(&self, other: &&[u8]) -> bool

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

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.

impl<const N: usize> PartialEq<&[u8; N]> for DigitSequence

fn eq(&self, other: &&[u8; N]) -> bool

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

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.

impl<const N: usize> PartialEq<[u8; N]> for DigitSequence

fn eq(&self, other: &[u8; N]) -> bool

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

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.

impl PartialEq<Vec<u8>> for DigitSequence

fn eq(&self, other: &Vec<u8>) -> bool

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

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.

impl PartialEq for DigitSequence

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

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

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.

impl PartialOrd for DigitSequence

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

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

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

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

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

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

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

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

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

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

impl TryFrom<&[u8]> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(digits: &[u8]) -> CrateResult<Self>

Performs the conversion.

impl<const N: usize> TryFrom<&[u8; N]> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(digits: &[u8; N]) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&DigitSequence> for u128

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&DigitSequence> for u16

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&DigitSequence> for u32

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&DigitSequence> for u64

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&DigitSequence> for u8

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&DigitSequence> for usize

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<&Vec<u8>> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: &Vec<u8>) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<DigitSequence> for u128

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<DigitSequence> for u16

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<DigitSequence> for u32

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<DigitSequence> for u64

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<DigitSequence> for u8

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<DigitSequence> for usize

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: DigitSequence) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<i128> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<i16> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<i32> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<i64> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<i8> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> CrateResult<Self>

Performs the conversion.

impl TryFrom<isize> for DigitSequence

type Error = CrateError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> CrateResult<Self>

Performs the conversion.

impl Eq for DigitSequence

impl StructuralPartialEq for DigitSequence