Struct nitrokey::SerialNumber

pub struct SerialNumber { /* fields omitted */ }

Serial number of a Nitrokey device.

The serial number can be formatted as a string using the ToString trait, and it can be parsed from a string using the FromStr trait. It can also be represented as a 32-bit unsigned integer using as_u32. This integer is the ID of the smartcard of the Nitrokey device.

Neither the format of the string representation nor the integer representation are guaranteed to stay the same for new firmware versions.

Methods

impl SerialNumber

pub fn empty() -> Self

Creates an emtpty serial number.

This function can be used to create a placeholder value or to compare a SerialNumber instance with an empty serial number.

pub fn as_u32(&self) -> u32

Returns the integer reprensentation of this serial number.

This integer currently is the ID of the smartcard of the Nitrokey device. Upcoming firmware versions might change the meaning of this representation, or add additional components to the serial number.

Trait Implementations

impl Clone for SerialNumber

fn clone(&self) -> SerialNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SerialNumber

impl Debug for SerialNumber

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

Formats the value using the given formatter.

impl Display for SerialNumber

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

Formats the value using the given formatter.

impl FromStr for SerialNumber

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SerialNumber, Error>

Try to parse a serial number from a hex string.

The input string must be a valid hex string. Optionally, it can include a 0x prefix.

Errors

• InvalidHexString if the given string is not a valid hex string

Example

use std::convert::TryFrom;
use nitrokey::{DeviceInfo, Error, SerialNumber};

fn find_device(serial_number: &str) -> Result<Option<DeviceInfo>, Error> {
    let serial_number: SerialNumber = serial_number.parse()?;
    Ok(nitrokey::list_devices()?
        .into_iter()
        .filter(|device| device.serial_number == Some(serial_number))
        .next())
}

impl PartialEq<SerialNumber> for SerialNumber

fn eq(&self, other: &SerialNumber) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SerialNumber) -> bool

This method tests for !=.

impl StructuralPartialEq for SerialNumber