Struct yubihsm::domain::Domain

pub struct Domain { /* 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 Domain

pub const DOM1: Domain

pub const DOM2: Domain

pub const DOM3: Domain

pub const DOM4: Domain

pub const DOM5: Domain

pub const DOM6: Domain

pub const DOM7: Domain

pub const DOM8: Domain

pub const DOM9: Domain

pub const DOM10: Domain

pub const DOM11: Domain

pub const DOM12: Domain

pub const DOM13: Domain

pub const DOM14: Domain

pub const DOM15: Domain

pub const DOM16: Domain

pub fn empty() -> Domain

Returns an empty set of flags.

pub fn all() -> Domain

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<Domain>

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

pub fn from_bits_truncate(bits: u16) -> Domain

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: Domain) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Domain

pub fn at(index: usize) -> Result<Self, Error>

Get the Domain object corresponding to the given-numbered domain e.g. Domain::at(1) returns Domain::DOM1.

Trait Implementations

impl PartialEq<Domain> for Domain

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

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

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

This method tests for !=.

impl Ord for Domain

fn cmp(&self, other: &Domain) -> 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 Clone for Domain

fn clone(&self) -> Domain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<Domain> for Domain

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

Extends a collection with the contents of an iterator.

impl Eq for Domain

impl Copy for Domain

impl PartialOrd<Domain> for Domain

fn partial_cmp(&self, other: &Domain) -> Option<Ordering>

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

fn lt(&self, other: &Domain) -> bool

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

fn le(&self, other: &Domain) -> bool

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

fn gt(&self, other: &Domain) -> bool

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

fn ge(&self, other: &Domain) -> bool

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

impl Hash for Domain

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, 

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

impl Sub<Domain> for Domain

type Output = Domain

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Domain> for Domain

fn sub_assign(&mut self, other: Domain)

Disables all flags enabled in the set.

impl Not for Domain

type Output = Domain

The resulting type after applying the ! operator.

fn not(self) -> Domain

Returns the complement of this set of flags.

impl BitAnd<Domain> for Domain

type Output = Domain

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<Domain> for Domain

type Output = Domain

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<Domain> for Domain

type Output = Domain

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<Domain> for Domain

fn bitand_assign(&mut self, other: Domain)

Disables all flags disabled in the set.

impl BitOrAssign<Domain> for Domain

fn bitor_assign(&mut self, other: Domain)

Adds the set of flags.

impl BitXorAssign<Domain> for Domain

fn bitxor_assign(&mut self, other: Domain)

Toggles the set of flags.

impl FromIterator<Domain> for Domain

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

Creates a value from an iterator.

impl Debug for Domain

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

Formats the value using the given formatter.

impl Octal for Domain

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

Formats the value using the given formatter.

impl Binary for Domain

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

Formats the value using the given formatter.

impl LowerHex for Domain

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

Formats the value using the given formatter.

impl UpperHex for Domain

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

Formats the value using the given formatter.

impl Serialize for Domain

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 Domain

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

Deserialize this value from the given Serde deserializer.