Struct StringRefHeader 

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

16-bit String Reference header entry.

Implementations

impl StringRefHeader

pub const RSVD1_MASK: u16

Mask of all reserved-as-1 bits.

pub const RSVD0_MASK: u16

Mask of all reserved-as-0 bits.

pub const DEFAULT: u16

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

pub const IS_INLINE_MASK: u16

Unshifted bitmask of is_inline.

pub const IS_INLINE_SHIFT: usize = 15

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

pub const ID_OR_LEN_MASK: u16

Unshifted bitmask of id_or_len.

pub const ID_OR_LEN_SHIFT: usize = 0

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

pub const FIELDS: [FieldMetadata<u16>; 2]

Metadata of all named fields in the layout.

pub const fn new() -> Self

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) -> u16

pub const fn is_inline(&self) -> bool

The value of StringRefHeader15.

pub const fn set_is_inline(&mut self, value: bool) -> &mut Self

Sets the value of StringRefHeader15.

pub const fn id_or_len(&self) -> u16

The value of StringRefHeader[14:0].

pub const fn set_id_or_len(&mut self, value: u16) -> &mut Self

Sets the value of StringRefHeader[14:0].

impl StringRefHeader

pub fn iter(&self) -> StringRefHeaderIter

Returns an iterator over (metadata, value) pairs for each field.

impl StringRefHeader

pub fn indexed(id: u16) -> Self

Constructs a StringRefHeader for an indexed string ref.

pub fn inline(len: u16) -> Self

Constructs a StringRefHeader for an inline string ref.

Trait Implementations

impl Binary for StringRefHeader

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

Formats the value using the given formatter.

impl Clone for StringRefHeader

fn clone(&self) -> StringRefHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StringRefHeader

impl Debug for StringRefHeader

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

Formats the value using the given formatter.

impl Default for StringRefHeader

fn default() -> Self

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

impl Eq for StringRefHeader

impl From<StringRefHeader> for u16

fn from(value: StringRefHeader) -> Self

Converts to this type from the input type.

impl From<u16> for StringRefHeader

fn from(value: u16) -> Self

Converts to this type from the input type.

impl IntoIterator for StringRefHeader

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

The type of the elements being iterated over.

type IntoIter = StringRefHeaderIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a StringRefHeader

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

The type of the elements being iterated over.

type IntoIter = StringRefHeaderIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for StringRefHeader

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

Formats the value using the given formatter.

impl Octal for StringRefHeader

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

Formats the value using the given formatter.

impl PartialEq for StringRefHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StringRefHeader

impl UpperHex for StringRefHeader

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

Formats the value using the given formatter.