Struct SubByte 

pub struct SubByte { /* private fields */ }

A sub-byte offset.

Implementations

impl SubByte

pub const MIN: Self

The minimum sub-byte offset value (0).

pub const MAX: Self

The maximum sub-byte offset value (7).

pub const fn new(bit: u8) -> Option<Self>

Create a new SubByte from a sub-byte offset.

Returns

Returns None if bit is 8 or greater, as it is not valid.

pub const unsafe fn new_unchecked(bit: u8) -> Self

Create a new SubByte from a sub-byte offset, without checking if it is valid.

Safety

Behaviour is undefined if bit is not less than 8.

pub const fn get(&self) -> u8

Returns the sub-byte offset as a u8.

Trait Implementations

impl Clone for SubByte

fn clone(&self) -> SubByte

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Hash for SubByte

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SubByte

fn cmp(&self, other: &SubByte) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SubByte

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SubByte

fn partial_cmp(&self, other: &SubByte) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SubByte

impl Eq for SubByte

impl StructuralPartialEq for SubByte