Struct Count

pub struct Count { /* private fields */ }

Represents byte counts.

Refer to the module documentation for more information.

Examples

use pkce_std::count::Count;

let count = Count::new(64).unwrap();

assert_eq!(count.get(), 64);

Implementations

impl Count

pub const MIN: Self

The minimum value of Self.

pub const DEFAULT: Self

The default value of Self.

pub const MAX: Self

The maximum value of Self.

pub const fn new(value: usize) -> Result<Self, Error>

Constructs Self if the provided value is in the valid range.

Errors

See check for more information.

pub const fn new_ok(value: usize) -> Option<Self>

Similar to new, but the error is discarded.

pub const fn check(value: usize) -> Result<(), Error>

Checks whether the given value is in the valid range for Self.

Errors

Error is returned if the value is less than MIN or greater than MAX.

pub const unsafe fn new_unchecked(value: usize) -> Self

Constructs Self without checking the value.

Safety

The caller must ensure that the value is in the valid range for Self.

pub const fn get(self) -> usize

Consumes Self and returns the contained value.

pub const fn encoded(self) -> usize

Returns the encoded length corresponding to the byte count.

Trait Implementations

impl Clone for Count

fn clone(&self) -> Count

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Count

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

Formats the value using the given formatter.

impl Default for Count

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Count

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Count

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

Formats the value using the given formatter.

impl From<Count> for Length

fn from(count: Count) -> Self

Converts to this type from the input type.

impl From<Count> for usize

fn from(count: Count) -> Self

Converts to this type from the input type.

impl FromStr for Count

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

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

impl Hash for Count

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 Count

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

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

fn partial_cmp(&self, other: &Count) -> 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 Serialize for Count

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<usize> for Count

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Count

impl Eq for Count

impl StructuralPartialEq for Count