Struct Tag 

pub struct Tag(/* private fields */);

Message tag definitions.

Implementations

impl Tag

pub const FINAL: Self

Indicates the end of the stream.

pub const MESSAGE: Self

Describes a normal message in a stream.

pub const PUSH: Self

Indicates the message marks the end of a series of messages in a stream, but not the end of the stream.

pub const REKEY: Self

Derives a new key for the stream.

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

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

Convert from a bits value, returning None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> Self

Convert from a bits value exactly.

Values containing unknown bits are rejected when passed to DryocStream::push, and authenticated unknown tags are rejected by Rustaceous pull streams.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub fn clear(&mut self)

Unsets all bits in the flags.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

pub const fn iter(&self) -> TagIter

Yield a set of contained flags values.

pub const fn iter_names(&self) -> TagIterNames

Yield a set of contained named flags values.

Trait Implementations

impl Binary for Tag

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

Formats the value using the given formatter.

impl BitAnd for Tag

type Output = Tag

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for Tag

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl BitOr for Tag

type Output = Tag

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Tag

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl BitXor for Tag

type Output = Tag

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for Tag

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Tag

impl Debug for Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Tag

impl Extend<Tag> for Tag

fn extend<T: IntoIterator<Item = Self>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Tag> for Tag

fn from_iter<T: IntoIterator<Item = Self>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Tag

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 IntoIterator for Tag

type IntoIter = TagIter

Which kind of iterator are we turning this into?

type Item = Tag

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Tag

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

Formats the value using the given formatter.

impl Not for Tag

type Output = Tag

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Octal for Tag

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

Formats the value using the given formatter.

impl PartialEq for Tag

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Tag

impl Sub for Tag

type Output = Tag

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Tag

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl TryFrom<u8> for Tag

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for Tag

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

Formats the value using the given formatter.