Struct ConfigCredentials

pub struct ConfigCredentials {
    role: UserRole,
    name: UserId,
    passphrase: Option<String>,
}

A set of credentials for a [NetHsm][nethsm::NetHsm]

Tracks the [UserRole], [UserId] and optionally the passphrase of the user.

Fields

role: UserRole

name: UserId

passphrase: Option<String>

Implementations

impl ConfigCredentials

pub fn new(role: UserRole, name: UserId, passphrase: Option<String>) -> Self

Creates a new ConfigCredentials

Examples

use nethsm::UserRole;
use nethsm_config::{ConfigCredentials, ConfigInteractivity};

// credentials for an Operator user with passphrase
ConfigCredentials::new(
    UserRole::Operator,
    "user1".parse()?,
    Some("my-passphrase".into()),
);

// credentials for an Administrator user without passphrase
ConfigCredentials::new(UserRole::Administrator, "admin1".parse()?, None);

pub fn get_name(&self) -> UserId

Returns the name (a [UserId])

pub fn get_role(&self) -> UserRole

Returns the role (a [UserRole])

pub fn get_passphrase(&self) -> Option<&str>

Returns the passphrase of the ConfigCredentials

pub fn set_passphrase(&mut self, passphrase: String)

Sets the passphrase of the ConfigCredentials

pub fn has_passphrase(&self) -> bool

Returns whether a passphrase is set for the ConfigCredentials

Trait Implementations

impl Clone for ConfigCredentials

fn clone(&self) -> ConfigCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigCredentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigCredentials

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ConfigCredentials> for Credentials

fn from(value: ConfigCredentials) -> Self

Converts to this type from the input type.

impl Hash for ConfigCredentials

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 ConfigCredentials

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for ConfigCredentials

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for ConfigCredentials

impl StructuralPartialEq for ConfigCredentials