Skip to main content

PresenceMap

Struct PresenceMap 

Source
pub struct PresenceMap { /* private fields */ }
Expand description

FAST presence map.

The presence map tracks which optional fields are present in a message. Bits are consumed in order as fields are decoded.

Implementations§

Source§

impl PresenceMap

Source

pub fn new() -> PresenceMap

Creates an empty presence map.

Source

pub fn from_bits(bits: Vec<bool>) -> PresenceMap

Creates a presence map from raw bits.

Source

pub fn decode(data: &[u8], offset: &mut usize) -> Result<PresenceMap, FastError>

Decodes a presence map from a byte slice.

§Arguments
  • data - The input bytes
  • offset - Current position in the data (will be updated)
§Returns

The decoded presence map.

§Errors

Returns FastError::UnexpectedEof if the data is incomplete.

Source

pub fn next_bit(&mut self) -> bool

Returns the next bit from the presence map.

§Returns

true if the field is present, false otherwise. Returns false if the map is exhausted.

Source

pub fn bit(&self, index: usize) -> bool

Returns the bit at the specified position without consuming it.

§Arguments
  • index - The bit position (0-indexed)
Source

pub fn len(&self) -> usize

Returns the number of bits in the presence map.

Source

pub fn is_empty(&self) -> bool

Returns true if the presence map is empty.

Source

pub fn position(&self) -> usize

Returns the current position in the presence map.

Source

pub fn reset(&mut self)

Resets the position to the beginning.

Source

pub fn encode(&self) -> Vec<u8>

Encodes the presence map to bytes.

§Returns

The encoded bytes with stop-bit encoding.

Trait Implementations§

Source§

impl Clone for PresenceMap

Source§

fn clone(&self) -> PresenceMap

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 PresenceMap

Source§

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

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

impl Default for PresenceMap

Source§

fn default() -> PresenceMap

Returns the “default value” for a type. Read more

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.