Struct ContextSwitchRecordHeader 

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

Header word for an FXT Context Switch record (RecordType = 8, SchedulerEventType = 1).

Implementations

impl ContextSwitchRecordHeader

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

Unshifted bitmask of event_type.

pub const EVENT_TYPE_SHIFT: usize = 60

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

pub const EVENT_TYPE_DEFAULT: u64

Pre-shifted default value of the event_type field.

pub const THREAD_STATE_MASK: u64

Unshifted bitmask of thread_state.

pub const THREAD_STATE_SHIFT: usize = 36

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

pub const CPU_NUMBER_MASK: u64

Unshifted bitmask of cpu_number.

pub const CPU_NUMBER_SHIFT: usize = 20

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

pub const ARG_COUNT_MASK: u64

Unshifted bitmask of arg_count.

pub const ARG_COUNT_SHIFT: usize = 16

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

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>; 6]

Metadata of all named fields in the layout.

pub const fn new() -> ContextSwitchRecordHeader

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 fn event_type(&self) -> SchedulerEventType

where SchedulerEventType: TryFromBytes,

The value of ContextSwitchRecordHeader[63:60].

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<SchedulerEventType, InvalidBits<u8>>

where SchedulerEventType: TryFromBytes,

Fallible variant of Self::event_type.

pub fn set_event_type( &mut self, value: SchedulerEventType, ) -> &mut ContextSwitchRecordHeader

where SchedulerEventType: IntoBytes + Immutable,

Sets the value of ContextSwitchRecordHeader[63:60].

pub const fn thread_state(&self) -> u8

The value of ContextSwitchRecordHeader[39:36].

pub const fn set_thread_state( &mut self, value: u8, ) -> &mut ContextSwitchRecordHeader

Sets the value of ContextSwitchRecordHeader[39:36].

pub const fn cpu_number(&self) -> u16

The value of ContextSwitchRecordHeader[35:20].

pub const fn set_cpu_number( &mut self, value: u16, ) -> &mut ContextSwitchRecordHeader

Sets the value of ContextSwitchRecordHeader[35:20].

pub const fn arg_count(&self) -> u8

The value of ContextSwitchRecordHeader[19:16].

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

Sets the value of ContextSwitchRecordHeader[19:16].

pub const fn record_size(&self) -> u16

The value of ContextSwitchRecordHeader[15:4].

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

Sets the value of ContextSwitchRecordHeader[15:4].

pub fn record_type(&self) -> RecordType

where RecordType: TryFromBytes,

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

where RecordType: IntoBytes + Immutable,

Sets the value of ContextSwitchRecordHeader[3:0].

impl ContextSwitchRecordHeader

pub fn iter(&self) -> ContextSwitchRecordHeaderIter

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

Trait Implementations

impl Binary for ContextSwitchRecordHeader

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

where SchedulerEventType: Debug, RecordType: Debug,

Formats the value using the given formatter.

impl Clone for ContextSwitchRecordHeader

fn clone(&self) -> ContextSwitchRecordHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ContextSwitchRecordHeader

impl Debug for ContextSwitchRecordHeader

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

Formats the value using the given formatter.

impl Default for ContextSwitchRecordHeader

fn default() -> ContextSwitchRecordHeader

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

impl Eq for ContextSwitchRecordHeader

impl From<u64> for ContextSwitchRecordHeader

fn from(value: u64) -> ContextSwitchRecordHeader

Converts to this type from the input type.

impl IntoIterator for ContextSwitchRecordHeader

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

The type of the elements being iterated over.

type IntoIter = ContextSwitchRecordHeaderIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a> IntoIterator for &'a ContextSwitchRecordHeader

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

The type of the elements being iterated over.

type IntoIter = ContextSwitchRecordHeaderIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for ContextSwitchRecordHeader

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

where SchedulerEventType: Debug, RecordType: Debug,

Formats the value using the given formatter.

impl Octal for ContextSwitchRecordHeader

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

where SchedulerEventType: Debug, RecordType: Debug,

Formats the value using the given formatter.

impl PartialEq for ContextSwitchRecordHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ContextSwitchRecordHeader

impl UpperHex for ContextSwitchRecordHeader

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

where SchedulerEventType: Debug, RecordType: Debug,

Formats the value using the given formatter.