Struct yubihsm::domains::Domains

pub struct Domains { /* fields omitted */ }

Logical partition within the YubiHSM2, allowing several clients to access the same device but access controlled on a domain-by-domain basis. For more information, see the Yubico documentation:

https://developers.yubico.com/YubiHSM2/Concepts/Domain.html

Methods

impl Domains

pub const DOMAIN_1: Domains

DOMAIN_1: Domains = Domains{bits: 1,}

pub const DOMAIN_2: Domains

DOMAIN_2: Domains = Domains{bits: 2,}

pub const DOMAIN_3: Domains

DOMAIN_3: Domains = Domains{bits: 4,}

pub const DOMAIN_4: Domains

DOMAIN_4: Domains = Domains{bits: 8,}

pub const DOMAIN_5: Domains

DOMAIN_5: Domains = Domains{bits: 16,}

pub const DOMAIN_6: Domains

DOMAIN_6: Domains = Domains{bits: 32,}

pub const DOMAIN_7: Domains

DOMAIN_7: Domains = Domains{bits: 64,}

pub const DOMAIN_8: Domains

DOMAIN_8: Domains = Domains{bits: 128,}

pub const DOMAIN_9: Domains

DOMAIN_9: Domains = Domains{bits: 256,}

pub const DOMAIN_10: Domains

DOMAIN_10: Domains = Domains{bits: 512,}

pub const DOMAIN_11: Domains

DOMAIN_11: Domains = Domains{bits: 1024,}

pub const DOMAIN_12: Domains

DOMAIN_12: Domains = Domains{bits: 2048,}

pub const DOMAIN_13: Domains

DOMAIN_13: Domains = Domains{bits: 4096,}

pub const DOMAIN_14: Domains

DOMAIN_14: Domains = Domains{bits: 8192,}

pub const DOMAIN_15: Domains

DOMAIN_15: Domains = Domains{bits: 16384,}

pub const DOMAIN_16: Domains

DOMAIN_16: Domains = Domains{bits: 32768,}

pub fn empty() -> Domains

Returns an empty set of flags.

pub fn all() -> Domains

Returns the set containing all flags.

pub fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u16) -> Option<Domains>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u16) -> Domains

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: Domains) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: Domains) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Domains)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Domains)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Domains)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Domains, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Copy for Domains

impl PartialEq for Domains

fn eq(&self, __arg_0: &Domains) -> bool

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

fn ne(&self, __arg_0: &Domains) -> bool

This method tests for !=.

impl Eq for Domains

impl Clone for Domains

fn clone(&self) -> Domains

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd for Domains

fn partial_cmp(&self, __arg_0: &Domains) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Domains) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Domains) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &Domains) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Domains) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for Domains

fn cmp(&self, __arg_0: &Domains) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for Domains

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for Domains

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

Formats the value using the given formatter.

impl Binary for Domains

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

Formats the value using the given formatter.

impl Octal for Domains

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

Formats the value using the given formatter.

impl LowerHex for Domains

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

Formats the value using the given formatter.

impl UpperHex for Domains

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

Formats the value using the given formatter.

impl BitOr for Domains

type Output = Domains

The resulting type after applying the | operator.

fn bitor(self, other: Domains) -> Domains

Returns the union of the two sets of flags.

impl BitOrAssign for Domains

fn bitor_assign(&mut self, other: Domains)

Adds the set of flags.

impl BitXor for Domains

type Output = Domains

The resulting type after applying the ^ operator.

fn bitxor(self, other: Domains) -> Domains

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign for Domains

fn bitxor_assign(&mut self, other: Domains)

Toggles the set of flags.

impl BitAnd for Domains

type Output = Domains

The resulting type after applying the & operator.

fn bitand(self, other: Domains) -> Domains

Returns the intersection between the two sets of flags.

impl BitAndAssign for Domains

fn bitand_assign(&mut self, other: Domains)

Disables all flags disabled in the set.

impl Sub for Domains

type Output = Domains

The resulting type after applying the - operator.

fn sub(self, other: Domains) -> Domains

Returns the set difference of the two sets of flags.

impl SubAssign for Domains

fn sub_assign(&mut self, other: Domains)

Disables all flags enabled in the set.

impl Not for Domains

type Output = Domains

The resulting type after applying the ! operator.

fn not(self) -> Domains

Returns the complement of this set of flags.

impl Extend<Domains> for Domains

fn extend<T: IntoIterator<Item = Domains>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<Domains> for Domains

fn from_iter<T: IntoIterator<Item = Domains>>(iterator: T) -> Domains

Creates a value from an iterator.

impl Serialize for Domains

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Domains

fn deserialize<D>(deserializer: D) -> Result<Domains, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.