Struct Bitfield

pub struct Bitfield { /* private fields */ }

A schema referencing some bits within a chunk of bytes.

Implementations

impl Bitfield

pub fn new( bytes: usize, width: usize, offset: usize, ) -> Result<Self, ValidationError>

Create a new bitfield.

pub fn bits(&self) -> usize

Width of the bitfield in bits.

pub fn bytes(&self) -> usize

pub fn mask(&self) -> u64

Mask to select the bits covered by the bitfield.

pub fn read(&self, value: u64) -> u64

Read the value of the bitfield from bytes.

pub fn write(&self, value: u64, target: &mut u64)

Write the value to the described bitfield.

Trait Implementations

impl Clone for Bitfield

fn clone(&self) -> Bitfield

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bitfield

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

Formats the value using the given formatter.

impl Decoder for Bitfield

type Error = DecodingError

Error decoding a value.

fn decode<R>(&self, target: &mut R) -> Result<Value, Self::Error>

where R: Read + ReadBytesExt,

Decode a value from a target with the given schema.

impl Default for Bitfield

fn default() -> Self

Returns the “default value” for a type.

impl Encoder for Bitfield

type Error = EncodingError

Error encoding a value.

fn encode<W>(&self, target: &mut W, value: &Value) -> Result<usize, Self::Error>

where W: Write + WriteBytesExt,

Write a Json value according to the schema.

impl From<Bitfield> for BooleanSchema

fn from(bf: Bitfield) -> Self

Converts to this type from the input type.

impl From<Bitfield> for IntegerSchema

fn from(bits: Bitfield) -> Self

Converts to this type from the input type.

impl Copy for Bitfield