Skip to main content

MessageFlags

Struct MessageFlags 

Source
pub struct MessageFlags(/* private fields */);
Expand description

A compact bitfield of message flags.

Implementations§

Source§

impl MessageFlags

Source

pub const FIRST_IN_BATCH: u32

Flag: this message is the first element in a batch.

Source

pub const LAST_IN_BATCH: u32

Flag: this message is the last element in a batch.

Source

pub const DEGRADE_ALLOWED: u32

Flag: downstream may degrade this message (e.g., fast/low-precision path).

Source

pub const fn empty() -> Self

Create an empty flag set.

Source

pub const fn from_bits(bits: u32) -> Self

Construct from raw bits (advanced).

Source

pub const fn bits(&self) -> &u32

Return the raw flag bits.

Source

pub const fn with(self, bit: u32) -> Self

Set a flag bit.

Source

pub const fn without(self, bit: u32) -> Self

Clear a flag bit.

Source

pub const fn contains(self, bit: u32) -> bool

Check whether a flag bit is set.

Source

pub const fn first_in_batch(self) -> Self

Return a copy with FIRST_IN_BATCH set.

Source

pub const fn last_in_batch(self) -> Self

Return a copy with LAST_IN_BATCH set.

Source

pub const fn allow_degrade(self) -> Self

Return a copy with DEGRADE_ALLOWED set.

Source

pub const fn is_first(self) -> bool

true if FIRST_IN_BATCH is set.

Source

pub const fn is_last(self) -> bool

true if LAST_IN_BATCH is set.

Source

pub const fn can_degrade(self) -> bool

true if DEGRADE_ALLOWED is set.

Trait Implementations§

Source§

impl Clone for MessageFlags

Source§

fn clone(&self) -> MessageFlags

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for MessageFlags

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for MessageFlags

Source§

impl Eq for MessageFlags

Source§

impl StructuralPartialEq for MessageFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.