Struct Length

pub struct Length { /* private fields */ }

Represents OTP secret lengths.

Implementations

impl Length

pub const MIN: Self

Available on non-crate feature unsafe-length only.

The minimum Self value.

pub const DEFAULT: Self

The default Self value.

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

Constructs Self, if possible.

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 if the provided value is valid for Self.

Errors

This function never fails when the unsafe-length feature is enabled. Otherwise, it returns an error containing the unsafe value provided.

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

Constructs Self without checking the length.

Safety

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

This invariant can be checked using check.

pub const fn recommended_for(algorithm: Algorithm) -> Self

Returns the recommended length for the given Algorithm.

pub const fn get(self) -> usize

Returns the length value.

Trait Implementations

impl Clone for Length

fn clone(&self) -> Length

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Length

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

Formats the value using the given formatter.

impl Default for Length

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Length

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 From<Length> for usize

fn from(length: Length) -> Self

Converts to this type from the input type.

impl Hash for Length

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 PartialEq for Length

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

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 Length

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 Length

impl Eq for Length

impl StructuralPartialEq for Length