Struct PinId 

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

The ID of a PIN within the namespace of a client.

It is recommended that applications use an enum that implements Into<PinId>.

Examples

use trussed_auth::PinId;

#[repr(u8)]
enum Pin {
    User = 0,
    Admin = 1,
    ResetCode = 2,
}

impl From<Pin> for PinId {
    fn from(pin: Pin) -> Self {
        (pin as u8).into()
    }
}

Implementations

impl PinId

pub fn path(&self) -> PathBuf

Get the path to the PIN id.

Path are of the form pin.XX where xx is the hexadecimal representation of the PIN number.

pub fn hex(&self) -> [u8; 2]

Get the hex representation of the PIN id

pub fn from_path(path: &str) -> Result<Self, PinIdFromStrError>

Parse a PinId path

Trait Implementations

impl Clone for PinId

fn clone(&self) -> PinId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PinId

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

Formats the value using the given formatter.

impl Default for PinId

fn default() -> PinId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PinId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PinId> for u8

fn from(id: PinId) -> Self

Converts to this type from the input type.

impl From<u8> for PinId

fn from(id: u8) -> Self

Converts to this type from the input type.

impl FromStr for PinId

type Err = PinIdFromStrError

The associated error which can be returned from parsing.

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

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

impl Hash for PinId

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 PinId

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PinId

impl Eq for PinId

impl StructuralPartialEq for PinId