Struct ArgumentHeader 

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

Header word for an FXT Argument.

Implementations

impl ArgumentHeader

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 VALUE_BITS_MASK: u64

Unshifted bitmask of value_bits.

pub const VALUE_BITS_SHIFT: usize = 32

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

pub const NAME_REF_MASK: u64

Unshifted bitmask of name_ref.

pub const NAME_REF_SHIFT: usize = 16

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

pub const SIZE_WORDS_MASK: u64

Unshifted bitmask of size_words.

pub const SIZE_WORDS_SHIFT: usize = 4

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

pub const ARG_TYPE_MASK: u64

Unshifted bitmask of arg_type.

pub const ARG_TYPE_SHIFT: usize = 0

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

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

Metadata of all named fields in the layout.

pub const fn new() -> ArgumentHeader

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 value_bits(&self) -> u32

The value of ArgumentHeader[63:32].

pub const fn set_value_bits(&mut self, value: u32) -> &mut ArgumentHeader

Sets the value of ArgumentHeader[63:32].

pub const fn name_ref(&self) -> u16

The value of ArgumentHeader[31:16].

pub const fn set_name_ref(&mut self, value: u16) -> &mut ArgumentHeader

Sets the value of ArgumentHeader[31:16].

pub const fn size_words(&self) -> u16

The value of ArgumentHeader[15:4].

pub const fn set_size_words(&mut self, value: u16) -> &mut ArgumentHeader

Sets the value of ArgumentHeader[15:4].

pub fn arg_type(&self) -> ArgumentType

where ArgumentType: TryFromBytes,

The value of ArgumentHeader[3:0].

Panics

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

pub fn try_arg_type(&self) -> Result<ArgumentType, InvalidBits<u8>>

where ArgumentType: TryFromBytes,

Fallible variant of Self::arg_type.

pub fn set_arg_type(&mut self, value: ArgumentType) -> &mut ArgumentHeader

where ArgumentType: IntoBytes + Immutable,

Sets the value of ArgumentHeader[3:0].

impl ArgumentHeader

pub fn iter(&self) -> ArgumentHeaderIter

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

impl ArgumentHeader

pub fn for_argument( name_ref: u16, size_words: u16, arg_type: ArgumentType, ) -> ArgumentHeader

Constructs an ArgumentHeader for an argument with the given name reference, size in words, and argument type.

Trait Implementations

impl Binary for ArgumentHeader

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

where ArgumentType: Debug,

Formats the value using the given formatter.

impl Clone for ArgumentHeader

fn clone(&self) -> ArgumentHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ArgumentHeader

impl Debug for ArgumentHeader

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

Formats the value using the given formatter.

impl Default for ArgumentHeader

fn default() -> ArgumentHeader

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

impl Eq for ArgumentHeader

impl From<u64> for ArgumentHeader

fn from(value: u64) -> ArgumentHeader

Converts to this type from the input type.

impl IntoIterator for ArgumentHeader

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

The type of the elements being iterated over.

type IntoIter = ArgumentHeaderIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a> IntoIterator for &'a ArgumentHeader

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

The type of the elements being iterated over.

type IntoIter = ArgumentHeaderIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for ArgumentHeader

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

where ArgumentType: Debug,

Formats the value using the given formatter.

impl Octal for ArgumentHeader

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

where ArgumentType: Debug,

Formats the value using the given formatter.

impl PartialEq for ArgumentHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ArgumentHeader

impl UpperHex for ArgumentHeader

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

where ArgumentType: Debug,

Formats the value using the given formatter.