Struct NetHsmMetricsUsers

pub struct NetHsmMetricsUsers {
    metrics_user: SystemWideUserId,
    operator_users: Vec<UserId>,
}

A set of users with unique [UserId]s, used for metrics retrieval

This struct tracks a user that is intended for the use in the [Metrics][nethsm::UserRole::Metrics] role and a list of users, that are intended to be used in the [Operator][nethsm::UserRole::Operator] role.

Fields

metrics_user: SystemWideUserId

operator_users: Vec<UserId>

Implementations

impl NetHsmMetricsUsers

pub fn new( metrics_user: SystemWideUserId, operator_users: Vec<UserId>, ) -> Result<Self, Error>

Creates a new NetHsmMetricsUsers

Error

Returns an error, if the provided [UserId] of the metrics_user is duplicated in the provided operator_users.

Examples

use nethsm_config::NetHsmMetricsUsers;

NetHsmMetricsUsers::new(
    "metrics1".parse()?,
    vec!["user1".parse()?, "user2".parse()?],
)?;

// this fails because there are duplicate UserIds
assert!(NetHsmMetricsUsers::new(
    "metrics1".parse()?,
    vec!["metrics1".parse()?, "user2".parse()?,],
)
.is_err());

pub fn get_users(&self) -> Vec<UserId>

Returns all tracked [UserId]s of the NetHsmMetricsUsers

Examples

use nethsm::UserId;
use nethsm_config::NetHsmMetricsUsers;

let nethsm_metrics_users = NetHsmMetricsUsers::new(
    "metrics1".parse()?,
    vec!["user1".parse()?, "user2".parse()?],
)?;

assert_eq!(
    nethsm_metrics_users.get_users(),
    vec![
        UserId::new("metrics1".to_string())?,
        UserId::new("user1".to_string())?,
        UserId::new("user2".to_string())?
    ]
);

Trait Implementations

impl Clone for NetHsmMetricsUsers

fn clone(&self) -> NetHsmMetricsUsers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetHsmMetricsUsers

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NetHsmMetricsUsers

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for NetHsmMetricsUsers

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 NetHsmMetricsUsers

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NetHsmMetricsUsers

impl StructuralPartialEq for NetHsmMetricsUsers