Struct Radix

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

A checked container for the radix to use when converting a string to an integer.

This type enforces that its value is in the range 2 and 36 inclusive, which is required by i64::from_str_radix.

This type is not part of the public API for parse but can be used on its own.

Implementations

impl Radix

pub fn new(radix: u32) -> Option<Self>

Construct a new Radix.

radix must be non-zero and between 2 and 36 inclusive; otherwise None is returned.

Examples

let radix = Radix::new(16);
assert!(matches!(radix, Some(radix) if radix.as_u32() == 16));

let invalid_radix = Radix::new(512);
assert_eq!(invalid_radix, None);

pub const unsafe fn new_unchecked(radix: u32) -> Self

Construct a new Radix without checking the value.

Safety

The given radix must not be zero. The given radix must be between 2 and 36 inclusive.

Examples

let radix = unsafe { Radix::new_unchecked(16) };
assert_eq!(radix.as_u32(), 16);

pub const fn as_u32(self) -> u32

Extract the Radix as the underlying u32.

Examples

for base in 2..=36 {
    let radix = Radix::new(base)?;
    assert_eq!(radix.as_u32(), base);
}

Trait Implementations

impl Clone for Radix

fn clone(&self) -> Radix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Radix

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

Formats the value using the given formatter.

impl Default for Radix

fn default() -> Self

The default radix is 10.

Examples

let default = Radix::default();
let base10 = Radix::new(10)?;
assert_eq!(default, base10);
assert_eq!(default.as_u32(), 10);

impl From<Radix> for u32

fn from(radix: Radix) -> Self

Converts to this type from the input type.

impl Hash for Radix

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 Ord for Radix

fn cmp(&self, other: &Radix) -> 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 PartialEq for Radix

fn eq(&self, other: &Radix) -> 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 PartialOrd for Radix

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

impl Copy for Radix

impl Eq for Radix

impl StructuralPartialEq for Radix