Struct RoundRobinMask

pub struct RoundRobinMask { /* private fields */ }

Mask representing which priority levels should be configured as round-robin

Implementations

impl RoundRobinMask

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl RoundRobinMask

pub const fn into_bytes(self) -> [u8; 4]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 4]) -> Self

Converts the given bytes directly into the bitfield struct.

impl RoundRobinMask

pub fn level0(&self) -> <bool as Specifier>::InOut

Returns the value of level0. Level 0

pub fn level0_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of level0.

#Errors

If the returned value contains an invalid bit pattern for level0. Level 0

pub fn with_level0(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of level0 set to the given value.

#Panics

If the given value is out of bounds for level0. Level 0

pub fn with_level0_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of level0 set to the given value.

#Errors

If the given value is out of bounds for level0. Level 0

pub fn set_level0(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of level0 to the given value.

#Panics

If the given value is out of bounds for level0. Level 0

pub fn set_level0_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of level0 to the given value.

#Errors

If the given value is out of bounds for level0. Level 0

pub fn level1(&self) -> <bool as Specifier>::InOut

Returns the value of level1. Level 1

pub fn level1_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of level1.

#Errors

If the returned value contains an invalid bit pattern for level1. Level 1

pub fn with_level1(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of level1 set to the given value.

#Panics

If the given value is out of bounds for level1. Level 1

pub fn with_level1_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of level1 set to the given value.

#Errors

If the given value is out of bounds for level1. Level 1

pub fn set_level1(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of level1 to the given value.

#Panics

If the given value is out of bounds for level1. Level 1

pub fn set_level1_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of level1 to the given value.

#Errors

If the given value is out of bounds for level1. Level 1

pub fn level2(&self) -> <bool as Specifier>::InOut

Returns the value of level2. Level 2

pub fn level2_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of level2.

#Errors

If the returned value contains an invalid bit pattern for level2. Level 2

pub fn with_level2(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of level2 set to the given value.

#Panics

If the given value is out of bounds for level2. Level 2

pub fn with_level2_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of level2 set to the given value.

#Errors

If the given value is out of bounds for level2. Level 2

pub fn set_level2(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of level2 to the given value.

#Panics

If the given value is out of bounds for level2. Level 2

pub fn set_level2_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of level2 to the given value.

#Errors

If the given value is out of bounds for level2. Level 2

pub fn level3(&self) -> <bool as Specifier>::InOut

Returns the value of level3. Level 3

pub fn level3_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of level3.

#Errors

If the returned value contains an invalid bit pattern for level3. Level 3

pub fn with_level3(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of level3 set to the given value.

#Panics

If the given value is out of bounds for level3. Level 3

pub fn with_level3_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of level3 set to the given value.

#Errors

If the given value is out of bounds for level3. Level 3

pub fn set_level3(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of level3 to the given value.

#Panics

If the given value is out of bounds for level3. Level 3

pub fn set_level3_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of level3 to the given value.

#Errors

If the given value is out of bounds for level3. Level 3

Trait Implementations

impl CheckTotalSizeMultipleOf8 for RoundRobinMask

type Size = TotalSize<[(); 0]>

impl Default for RoundRobinMask

fn default() -> Self

Returns the “default value” for a type.

impl From<RoundRobinMask> for u32

where [(); 32]: IsU32Compatible,

fn from(__bf_bitfield: RoundRobinMask) -> Self

Converts to this type from the input type.

impl From<u32> for RoundRobinMask

where [(); 32]: IsU32Compatible,

fn from(__bf_prim: u32) -> Self

Converts to this type from the input type.