Struct strobe_rs::OpFlags

pub struct OpFlags { /* fields omitted */ }

Operation flags defined in the Strobe paper. This is defined as a bitflags struct.

Methods

impl OpFlags

pub const I: OpFlags

I: OpFlags = OpFlags{bits: 1 << 0,}

Is data being moved inbound

pub const A: OpFlags

A: OpFlags = OpFlags{bits: 1 << 1,}

Is data being sent to the application

pub const C: OpFlags

C: OpFlags = OpFlags{bits: 1 << 2,}

Does this operation use cipher output

pub const T: OpFlags

T: OpFlags = OpFlags{bits: 1 << 3,}

Is data being sent for transport

pub const M: OpFlags

M: OpFlags = OpFlags{bits: 1 << 4,}

Use exclusively for metadata operations

pub const K: OpFlags

K: OpFlags = OpFlags{bits: 1 << 5,}

Reserved and currently unimplemented. Using this will cause a panic.

pub fn empty() -> OpFlags

Returns an empty set of flags.

pub fn all() -> OpFlags

Returns the set containing all flags.

pub fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<OpFlags>

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

pub fn from_bits_truncate(bits: u8) -> OpFlags

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Copy for OpFlags

impl PartialEq for OpFlags

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

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

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

This method tests for !=.

impl Eq for OpFlags

impl Clone for OpFlags

fn clone(&self) -> OpFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd for OpFlags

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

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

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

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

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

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

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

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

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

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

impl Ord for OpFlags

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

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 Debug for OpFlags

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

Formats the value using the given formatter.

impl Binary for OpFlags

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

Formats the value using the given formatter.

impl Octal for OpFlags

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

Formats the value using the given formatter.

impl LowerHex for OpFlags

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

Formats the value using the given formatter.

impl UpperHex for OpFlags

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

Formats the value using the given formatter.

impl BitOr for OpFlags

type Output = OpFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign for OpFlags

fn bitor_assign(&mut self, other: OpFlags)

Adds the set of flags.

impl BitXor for OpFlags

type Output = OpFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign for OpFlags

fn bitxor_assign(&mut self, other: OpFlags)

Toggles the set of flags.

impl BitAnd for OpFlags

type Output = OpFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign for OpFlags

fn bitand_assign(&mut self, other: OpFlags)

Disables all flags disabled in the set.

impl Sub for OpFlags

type Output = OpFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign for OpFlags

fn sub_assign(&mut self, other: OpFlags)

Disables all flags enabled in the set.

impl Not for OpFlags

type Output = OpFlags

The resulting type after applying the ! operator.

fn not(self) -> OpFlags

Returns the complement of this set of flags.

impl Extend<OpFlags> for OpFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<OpFlags> for OpFlags

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

Creates a value from an iterator.