Struct AlphanumericStepper 

pub struct AlphanumericStepper<T = u32> { /* private fields */ }

A reversible alphanumeric sequence codec for compact serial codes like 000..999, A00..Z99, AA0..ZZ9, and AAA..ZZZ.

Implementations

impl<T> AlphanumericStepper<T>

pub const fn width(&self) -> usize

Returns the width.

impl<T: Copy> AlphanumericStepper<T>

pub fn max_number(&self) -> T

Returns the maximum number that can be encoded.

impl AlphanumericStepper<u8>

pub fn new(width: usize) -> Result<Self, AlphanumericStepperBuildError>

Creates a new AlphanumericStepper instance with the specified width.

pub fn encode( &self, number: u8, ) -> Result<String, AlphanumericStepperEncodeError>

Encodes a number into a string.

pub fn encode_to_string( &self, number: u8, s: &mut String, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a string.

pub fn encode_to_vec( &self, number: u8, v: &mut Vec<u8>, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a byte vector.

pub fn encode_to_writer<W>( &self, number: u8, writer: &mut W, ) -> Result<(), AlphanumericStepperEncodeWriteError>

where W: Write + ?Sized,

Available on crate feature std only.

Encodes a number and writes the result to an I/O writer.

pub fn decode( &self, s: impl AsRef<str>, ) -> Result<u8, AlphanumericStepperDecodeError>

Decodes a string into a number.

impl AlphanumericStepper<u16>

pub fn new(width: usize) -> Result<Self, AlphanumericStepperBuildError>

Creates a new AlphanumericStepper instance with the specified width.

pub fn encode( &self, number: u16, ) -> Result<String, AlphanumericStepperEncodeError>

Encodes a number into a string.

pub fn encode_to_string( &self, number: u16, s: &mut String, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a string.

pub fn encode_to_vec( &self, number: u16, v: &mut Vec<u8>, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a byte vector.

pub fn encode_to_writer<W>( &self, number: u16, writer: &mut W, ) -> Result<(), AlphanumericStepperEncodeWriteError>

where W: Write + ?Sized,

Available on crate feature std only.

Encodes a number and writes the result to an I/O writer.

pub fn decode( &self, s: impl AsRef<str>, ) -> Result<u16, AlphanumericStepperDecodeError>

Decodes a string into a number.

impl AlphanumericStepper<u32>

pub fn new(width: usize) -> Result<Self, AlphanumericStepperBuildError>

Creates a new AlphanumericStepper instance with the specified width.

pub fn encode( &self, number: u32, ) -> Result<String, AlphanumericStepperEncodeError>

Encodes a number into a string.

pub fn encode_to_string( &self, number: u32, s: &mut String, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a string.

pub fn encode_to_vec( &self, number: u32, v: &mut Vec<u8>, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a byte vector.

pub fn encode_to_writer<W>( &self, number: u32, writer: &mut W, ) -> Result<(), AlphanumericStepperEncodeWriteError>

where W: Write + ?Sized,

Available on crate feature std only.

Encodes a number and writes the result to an I/O writer.

pub fn decode( &self, s: impl AsRef<str>, ) -> Result<u32, AlphanumericStepperDecodeError>

Decodes a string into a number.

impl AlphanumericStepper<u64>

pub fn new(width: usize) -> Result<Self, AlphanumericStepperBuildError>

Creates a new AlphanumericStepper instance with the specified width.

pub fn encode( &self, number: u64, ) -> Result<String, AlphanumericStepperEncodeError>

Encodes a number into a string.

pub fn encode_to_string( &self, number: u64, s: &mut String, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a string.

pub fn encode_to_vec( &self, number: u64, v: &mut Vec<u8>, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a byte vector.

pub fn encode_to_writer<W>( &self, number: u64, writer: &mut W, ) -> Result<(), AlphanumericStepperEncodeWriteError>

where W: Write + ?Sized,

Available on crate feature std only.

Encodes a number and writes the result to an I/O writer.

pub fn decode( &self, s: impl AsRef<str>, ) -> Result<u64, AlphanumericStepperDecodeError>

Decodes a string into a number.

impl AlphanumericStepper<u128>

pub fn new(width: usize) -> Result<Self, AlphanumericStepperBuildError>

Creates a new AlphanumericStepper instance with the specified width.

pub fn encode( &self, number: u128, ) -> Result<String, AlphanumericStepperEncodeError>

Encodes a number into a string.

pub fn encode_to_string( &self, number: u128, s: &mut String, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a string.

pub fn encode_to_vec( &self, number: u128, v: &mut Vec<u8>, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a byte vector.

pub fn encode_to_writer<W>( &self, number: u128, writer: &mut W, ) -> Result<(), AlphanumericStepperEncodeWriteError>

where W: Write + ?Sized,

Available on crate feature std only.

Encodes a number and writes the result to an I/O writer.

pub fn decode( &self, s: impl AsRef<str>, ) -> Result<u128, AlphanumericStepperDecodeError>

Decodes a string into a number.

impl AlphanumericStepper<usize>

pub fn new(width: usize) -> Result<Self, AlphanumericStepperBuildError>

Creates a new AlphanumericStepper instance with the specified width.

pub fn encode( &self, number: usize, ) -> Result<String, AlphanumericStepperEncodeError>

Encodes a number into a string.

pub fn encode_to_string( &self, number: usize, s: &mut String, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a string.

pub fn encode_to_vec( &self, number: usize, v: &mut Vec<u8>, ) -> Result<(), AlphanumericStepperEncodeError>

Encodes a number and appends the result to a byte vector.

pub fn encode_to_writer<W>( &self, number: usize, writer: &mut W, ) -> Result<(), AlphanumericStepperEncodeWriteError>

where W: Write + ?Sized,

Available on crate feature std only.

Encodes a number and writes the result to an I/O writer.

pub fn decode( &self, s: impl AsRef<str>, ) -> Result<usize, AlphanumericStepperDecodeError>

Decodes a string into a number.

Trait Implementations

impl<T: Clone> Clone for AlphanumericStepper<T>

fn clone(&self) -> AlphanumericStepper<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AlphanumericStepper<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for AlphanumericStepper<T>

impl<T: PartialEq> PartialEq for AlphanumericStepper<T>

fn eq(&self, other: &AlphanumericStepper<T>) -> 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<T> StructuralPartialEq for AlphanumericStepper<T>