Struct google_api_proto::google::firestore::v1::BitSequence

pub struct BitSequence {
    pub bitmap: Bytes,
    pub padding: i32,
}

A sequence of bits, encoded in a byte array.

Each byte in the bitmap byte array stores 8 bits of the sequence. The only exception is the last byte, which may store 8 or fewer bits. The padding defines the number of bits of the last byte to be ignored as “padding”. The values of these “padding” bits are unspecified and must be ignored.

To retrieve the first bit, bit 0, calculate: (bitmap\[0\] & 0x01) != 0. To retrieve the second bit, bit 1, calculate: (bitmap\[0\] & 0x02) != 0. To retrieve the third bit, bit 2, calculate: (bitmap\[0\] & 0x04) != 0. To retrieve the fourth bit, bit 3, calculate: (bitmap\[0\] & 0x08) != 0. To retrieve bit n, calculate: (bitmap\[n / 8\] & (0x01 << (n % 8))) != 0.

The “size” of a BitSequence (the number of bits it contains) is calculated by this formula: (bitmap.length * 8) - padding.

Fields

bitmap: Bytes

The bytes that encode the bit sequence. May have a length of zero.

padding: i32

The number of bits of the last byte in bitmap to ignore as “padding”. If the length of bitmap is zero, then this value must be 0. Otherwise, this value must be between 0 and 7, inclusive.

Trait Implementations

impl Clone for BitSequence

fn clone(&self) -> BitSequence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitSequence

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

Formats the value using the given formatter.

impl Default for BitSequence

fn default() -> Self

Returns the “default value” for a type.

impl Message for BitSequence

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BitSequence

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