Struct LargeRecordHeader 

pub struct LargeRecordHeader(/* private fields */);

Header word for a large FXT record (RecordType = 15).

Implementations

impl LargeRecordHeader

pub const RSVD1_MASK: u64

Mask of all reserved-as-1 bits.

pub const RSVD0_MASK: u64

Mask of all reserved-as-0 bits.

pub const DEFAULT: u64

The default value of the layout, combining all field defaults and reserved-as values.

pub const LARGE_TYPE_MASK: u64

Unshifted bitmask of large_type.

pub const LARGE_TYPE_SHIFT: usize = 36

Bit shift (i.e., the low bit) of large_type.

pub const RECORD_SIZE_MASK: u64

Unshifted bitmask of record_size.

pub const RECORD_SIZE_SHIFT: usize = 4

Bit shift (i.e., the low bit) of record_size.

pub const RECORD_TYPE_MASK: u64

Unshifted bitmask of record_type.

pub const RECORD_TYPE_SHIFT: usize = 0

Bit shift (i.e., the low bit) of record_type.

pub const RECORD_TYPE_DEFAULT: u64

Pre-shifted default value of the record_type field.

pub const FIELDS: [FieldMetadata<u64>; 3]

Metadata of all named fields in the layout.

pub const fn new() -> LargeRecordHeader

Creates a new instance with reserved-as-1 bits set and all other bits zeroed (i.e., with a value of Self::RSVD1_MASK).

pub const fn bits(self) -> u64

pub const fn large_type(&self) -> u8

The value of LargeRecordHeader[39:36].

pub const fn set_large_type(&mut self, value: u8) -> &mut LargeRecordHeader

Sets the value of LargeRecordHeader[39:36].

pub const fn record_size(&self) -> u32

The value of LargeRecordHeader[35:4].

pub const fn set_record_size(&mut self, value: u32) -> &mut LargeRecordHeader

Sets the value of LargeRecordHeader[35:4].

pub fn record_type(&self) -> RecordType

where RecordType: TryFromBytes,

The value of LargeRecordHeader[3:0].

Panics

Panics if the field’s bit pattern is not a valid value of the custom representation. Use Self::try_record_type to recover from invalid bit patterns.

pub fn try_record_type(&self) -> Result<RecordType, InvalidBits<u8>>

where RecordType: TryFromBytes,

Fallible variant of Self::record_type.

pub fn set_record_type(&mut self, value: RecordType) -> &mut LargeRecordHeader

where RecordType: IntoBytes + Immutable,

Sets the value of LargeRecordHeader[3:0].

impl LargeRecordHeader

pub fn iter(&self) -> LargeRecordHeaderIter

Returns an iterator over ([metadata][bitrs::FieldMetadata], value) pairs for each field.

Trait Implementations

impl Binary for LargeRecordHeader

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

where RecordType: Debug,

Formats the value using the given formatter.

impl Clone for LargeRecordHeader

fn clone(&self) -> LargeRecordHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LargeRecordHeader

impl Debug for LargeRecordHeader

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

Formats the value using the given formatter.

impl Default for LargeRecordHeader

fn default() -> LargeRecordHeader

Returns an instance with the default bits set (i.e,. with a value of Self::DEFAULT.

impl Eq for LargeRecordHeader

impl From<u64> for LargeRecordHeader

fn from(value: u64) -> LargeRecordHeader

Converts to this type from the input type.

impl IntoIterator for LargeRecordHeader

type Item = (&'static FieldMetadata<u64>, u64)

The type of the elements being iterated over.

type IntoIter = LargeRecordHeaderIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <LargeRecordHeader as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a LargeRecordHeader

type Item = (&'static FieldMetadata<u64>, u64)

The type of the elements being iterated over.

type IntoIter = LargeRecordHeaderIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a LargeRecordHeader as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for LargeRecordHeader

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

where RecordType: Debug,

Formats the value using the given formatter.

impl Octal for LargeRecordHeader

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

where RecordType: Debug,

Formats the value using the given formatter.

impl PartialEq for LargeRecordHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LargeRecordHeader

impl UpperHex for LargeRecordHeader

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

where RecordType: Debug,

Formats the value using the given formatter.