DiscardableFlag

Struct DiscardableFlag 

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

1-bit discardable flag + 7 reserved bits packed into a u8.

The discardable flag indicates whether an option can be safely ignored by receivers that don’t understand it. The remaining 7 bits are reserved and should be set to 0.

Implementations§

Source§

impl DiscardableFlag

Source

pub fn new() -> Self

Create a new DiscardableFlag with all bits set to 0.

§Returns

A DiscardableFlag with discardable=false and reserved=0

Source

pub fn from_bool(discardable: bool) -> Self

Create a DiscardableFlag from a boolean value.

§Parameters
  • discardable - True to set the discardable bit, false to clear it
§Returns

A DiscardableFlag with the specified discardable bit and reserved=0

Source

pub fn is_discardable(&self) -> bool

Check if the discardable bit is set.

§Returns

True if the option can be discarded, false otherwise

Source

pub fn set_discardable(&mut self, discardable: bool)

Set or clear the discardable bit.

§Parameters
  • discardable - True to set the bit, false to clear it
Source

pub fn reserved(&self) -> u8

Get the 7-bit reserved field value.

§Returns

The lower 7 bits (should be 0 in well-formed packets)

Source

pub fn as_u8(&self) -> u8

Convert to the u8 wire format representation.

§Returns

The packed byte with discardable bit (MSB) and reserved bits

Source

pub fn from_u8(value: u8) -> Self

Create a DiscardableFlag from a u8 value.

§Parameters
  • value - The byte value (bit 7 = discardable, bits 6-0 = reserved)
§Returns

A DiscardableFlag with the specified bit pattern

Trait Implementations§

Source§

impl Clone for DiscardableFlag

Source§

fn clone(&self) -> DiscardableFlag

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 DiscardableFlag

Source§

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

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

impl PartialEq for DiscardableFlag

Source§

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

Source§

impl Eq for DiscardableFlag

Source§

impl StructuralPartialEq for DiscardableFlag

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, 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.