Struct Header

#[repr(transparent)]
struct Header(u8);

Header (metadata) of the encoded row.

Layout (most to least significant bits):

| magic | reserved | offset |
|   1   |    5     |   2    |

Tuple Fields

0: u8

Implementations

impl Header

const MAGIC_BITS: usize = 1usize

const MAGIC_OFFSET: usize = 7usize

const OFFSET_BITS: usize = 2usize

const OFFSET_OFFSET: usize = 0usize

const fn new() -> Self

Creates a new default initialized bitfield.

const fn from_bits(bits: u8) -> Self

Convert from bits.

const fn into_bits(self) -> u8

Convert into bits.

const fn magic(&self) -> bool

Magic bit to indicate it’s column-aware encoding. Note that in plain value encoding, the first byte is always 0 or 1 for nullability, of which the most significant bit is always 0.

Bits: 7..8

const fn offset(&self) -> OffsetWidth

Indicate the offset width of the encoded data.

Bits: 0..2

const fn with_offset_checked(self, value: OffsetWidth) -> Result<Self, ()>

Indicate the offset width of the encoded data.

Bits: 0..2

const fn with_offset(self, value: OffsetWidth) -> Self

Indicate the offset width of the encoded data.

Bits: 0..2

const fn set_offset(&mut self, value: OffsetWidth)

Indicate the offset width of the encoded data.

Bits: 0..2

const fn set_offset_checked(&mut self, value: OffsetWidth) -> Result<(), ()>

Indicate the offset width of the encoded data.

Bits: 0..2

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl From<Header> for u8

fn from(v: Header) -> u8

Converts to this type from the input type.

impl From<u8> for Header

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for Header

fn eq(&self, other: &Header) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Header

impl Eq for Header

impl StructuralPartialEq for Header