Struct binary_data_schema::Bitfield

pub struct Bitfield { /* fields omitted */ }

A schema referencing some bits within a chunk of bytes.

Implementations

impl Bitfield

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

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.

Example

use binary_data_schema::Bitfield;

let bf = Bitfield::new(2, 3, 7)?;
let mut buffer = 0;
bf.write(21, &mut buffer);
// 21 & 0b111 = 5;
assert_eq!(buffer, (5 << 7));

Trait Implementations

impl Clone for Bitfield

fn clone(&self) -> Bitfield

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Bitfield

impl Debug for Bitfield

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

Formats the value using the given formatter.

impl Decoder for Bitfield

fn decode<R>(&self, target: &mut R) -> Result<Value> where
    R: Read + ReadBytesExt, 

impl Default for Bitfield

fn default() -> Self

Returns the "default value" for a type.

impl Encoder for Bitfield

fn encode<W>(&self, target: &mut W, value: &Value) -> Result<usize> where
    W: Write + WriteBytesExt, 

Write a Json value according to the schema.

impl From<Bitfield> for IntegerSchema

fn from(bits: Bitfield) -> Self

Performs the conversion.

impl From<Bitfield> for BooleanSchema

fn from(bf: Bitfield) -> Self

Performs the conversion.