Struct EventRecordHeader 

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

Header word for an FXT Event record (RecordType = 4).

Implementations

impl EventRecordHeader

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

Unshifted bitmask of name_ref.

pub const NAME_REF_SHIFT: usize = 48

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

pub const CATEGORY_REF_MASK: u64

Unshifted bitmask of category_ref.

pub const CATEGORY_REF_SHIFT: usize = 32

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

pub const THREAD_REF_MASK: u64

Unshifted bitmask of thread_ref.

pub const THREAD_REF_SHIFT: usize = 24

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

pub const ARG_COUNT_MASK: u64

Unshifted bitmask of arg_count.

pub const ARG_COUNT_SHIFT: usize = 20

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

pub const EVENT_TYPE_MASK: u64

Unshifted bitmask of event_type.

pub const EVENT_TYPE_SHIFT: usize = 16

Bit shift (i.e., the low bit) of event_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>; 7]

Metadata of all named fields in the layout.

pub const fn new() -> EventRecordHeader

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 name_ref(&self) -> u16

The value of EventRecordHeader[63:48].

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

Sets the value of EventRecordHeader[63:48].

pub const fn category_ref(&self) -> u16

The value of EventRecordHeader[47:32].

pub const fn set_category_ref(&mut self, value: u16) -> &mut EventRecordHeader

Sets the value of EventRecordHeader[47:32].

pub const fn thread_ref(&self) -> u8

The value of EventRecordHeader[31:24].

pub const fn set_thread_ref(&mut self, value: u8) -> &mut EventRecordHeader

Sets the value of EventRecordHeader[31:24].

pub const fn arg_count(&self) -> u8

The value of EventRecordHeader[23:20].

pub const fn set_arg_count(&mut self, value: u8) -> &mut EventRecordHeader

Sets the value of EventRecordHeader[23:20].

pub fn event_type(&self) -> EventType

where EventType: TryFromBytes,

The value of EventRecordHeader[19:16].

Panics

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

pub fn try_event_type(&self) -> Result<EventType, InvalidBits<u8>>

where EventType: TryFromBytes,

Fallible variant of Self::event_type.

pub fn set_event_type(&mut self, value: EventType) -> &mut EventRecordHeader

where EventType: IntoBytes + Immutable,

Sets the value of EventRecordHeader[19:16].

pub const fn record_size(&self) -> u16

The value of EventRecordHeader[15:4].

pub const fn set_record_size(&mut self, value: u16) -> &mut EventRecordHeader

Sets the value of EventRecordHeader[15:4].

pub fn record_type(&self) -> RecordType

where RecordType: TryFromBytes,

The value of EventRecordHeader[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 EventRecordHeader

where RecordType: IntoBytes + Immutable,

Sets the value of EventRecordHeader[3:0].

impl EventRecordHeader

pub fn iter(&self) -> EventRecordHeaderIter

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

Trait Implementations

impl Binary for EventRecordHeader

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

where EventType: Debug, RecordType: Debug,

Formats the value using the given formatter.

impl Clone for EventRecordHeader

fn clone(&self) -> EventRecordHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EventRecordHeader

impl Debug for EventRecordHeader

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

Formats the value using the given formatter.

impl Default for EventRecordHeader

fn default() -> EventRecordHeader

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

impl Eq for EventRecordHeader

impl From<u64> for EventRecordHeader

fn from(value: u64) -> EventRecordHeader

Converts to this type from the input type.

impl IntoIterator for EventRecordHeader

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

The type of the elements being iterated over.

type IntoIter = EventRecordHeaderIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a> IntoIterator for &'a EventRecordHeader

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

The type of the elements being iterated over.

type IntoIter = EventRecordHeaderIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for EventRecordHeader

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

where EventType: Debug, RecordType: Debug,

Formats the value using the given formatter.

impl Octal for EventRecordHeader

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

where EventType: Debug, RecordType: Debug,

Formats the value using the given formatter.

impl PartialEq for EventRecordHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EventRecordHeader

impl UpperHex for EventRecordHeader

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

where EventType: Debug, RecordType: Debug,

Formats the value using the given formatter.