Struct KeyId

pub struct KeyId(String);

A unique key identifier for a private key on a NetHSM.

A KeyIds must be in the character set [a-z0-9] and must not be empty. It is used in key management on a NetHSM and is unique in its scope. The same KeyId may exist system-wide and in one or several namespaces, but no duplicate KeyId can exist system-wide or in the same namespace.

Tuple Fields

0: String

Implementations

impl KeyId

pub fn new(key_id: String) -> Result<Self, Error>

Constructs a new Key ID from a String.

Validates the input string and returns crate::Error::Key if it is invalid.

Errors

Returns an Error if

• string contains characters outside of the allowed range ([a-z0-9])
• string is empty

Examples

use nethsm::KeyId;

assert!(KeyId::new("key1".into()).is_ok());
assert!(KeyId::new("key".into()).is_ok());

// the input can not contain invalid chars
assert!(KeyId::new("key1#".into()).is_err());
assert!(KeyId::new("key~1".into()).is_err());

// the key must be non-empty
assert!(KeyId::new("".into()).is_err());

Trait Implementations

impl AsRef<str> for KeyId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyId

fn clone(&self) -> KeyId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyId

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

Formats the value using the given formatter.

impl From<KeyId> for String

fn from(value: KeyId) -> Self

Converts to this type from the input type.

impl FromStr for KeyId

type Err = Error

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 KeyId

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 KeyId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&String> for KeyId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for KeyId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for KeyId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for KeyId

impl StructuralPartialEq for KeyId