Struct sttp::transport::OperationalModes

pub struct OperationalModes(_);

Enumeration of the possible modes that affect how DataPublisher and DataSubscriber communicate during as STTP session.

Operational modes are sent from a subscriber to a publisher to request operational behaviors for the connection, as a result the operation modes must be sent before any other command. The publisher may silently refuse some requests (e.g., compression) based on its configuration. Operational modes only apply to fundamental protocol control.

Trait Implementations

impl Binary for OperationalModes

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

Formats the value using the given formatter.

impl BitAnd<OperationalModes> for OperationalModes

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

Returns the intersection between the two sets of flags.

type Output = OperationalModes

The resulting type after applying the & operator.

impl BitAndAssign<OperationalModes> for OperationalModes

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitFlags for OperationalModes

type Bits = u32

The underlying integer type.

type Iter = Iter

An iterator over enabled flags in an instance of the type.

type IterNames = IterRaw

An iterator over the raw names and bits for enabled flags in an instance of the type.

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits(bits: u32) -> Option<OperationalModes>

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

fn from_bits_truncate(bits: u32) -> OperationalModes

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

fn from_bits_retain(bits: u32) -> OperationalModes

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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

Get the flag for a particular name.

fn iter(&self) -> Self::Iter

Iterate over enabled flag values.

fn iter_names(&self) -> Self::IterNames

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

fn insert(&mut self, other: OperationalModes)

Inserts the specified flags in-place.

fn remove(&mut self, other: OperationalModes)

Removes the specified flags in-place.

fn toggle(&mut self, other: OperationalModes)

Toggles the specified flags in-place.

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

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

impl BitOr<OperationalModes> for OperationalModes

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

Returns the union of the two sets of flags.

type Output = OperationalModes

The resulting type after applying the | operator.

impl BitOrAssign<OperationalModes> for OperationalModes

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<OperationalModes> for OperationalModes

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

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

type Output = OperationalModes

The resulting type after applying the ^ operator.

impl BitXorAssign<OperationalModes> for OperationalModes

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for OperationalModes

fn clone(&self) -> OperationalModes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OperationalModes

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

Formats the value using the given formatter.

impl Default for OperationalModes

fn default() -> OperationalModes

Returns the “default value” for a type.

impl Extend<OperationalModes> for OperationalModes

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: 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<OperationalModes> for OperationalModes

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

Creates a value from an iterator.

impl Hash for OperationalModes

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 OperationalModes

type Item = OperationalModes

The type of the elements being iterated over.

type IntoIter = Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for OperationalModes

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

Formats the value using the given formatter.

impl Not for OperationalModes

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = OperationalModes

The resulting type after applying the ! operator.

impl Octal for OperationalModes

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

Formats the value using the given formatter.

impl Ord for OperationalModes

fn cmp(&self, other: &OperationalModes) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<OperationalModes> for OperationalModes

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<OperationalModes> for OperationalModes

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

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

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

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

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

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

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

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

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

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

impl PublicFlags for OperationalModes

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<OperationalModes> for OperationalModes

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

Returns the set difference of the two sets of flags.

type Output = OperationalModes

The resulting type after applying the - operator.

impl SubAssign<OperationalModes> for OperationalModes

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for OperationalModes

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

Formats the value using the given formatter.

impl Copy for OperationalModes

impl Eq for OperationalModes

impl StructuralEq for OperationalModes

impl StructuralPartialEq for OperationalModes