Struct midly::num::u7

#[repr(transparent)]
pub struct u7(_);

A 7-bit integer type.

Wraps the u8 type and ensures that the top bit is always zero.

Implementations

impl u7

pub const fn max_value() -> u7

The maximum value that this restricted integer can hold.

pub const fn new(raw: u8) -> u7

Creates a restricted int from its non-restricted counterpart by masking off the extra bits.

pub const fn from_int_lossy(raw: u8) -> u7

Creates a restricted int from its non-restricted counterpart by masking off the extra bits.

pub fn try_from(raw: u8) -> Option<u7>

Returns Some if the raw integer is within range of the restricted integer, and None otherwise.

pub fn as_int(self) -> u8

Get the inner integer out of the wrapper. The inner integer is guaranteed to be in range of the restricted wrapper.

pub fn slice_try_from_int(raw: &[u8]) -> Option<&[u7]>

Cast a slice of raw integers to a slice of restricted integers, only if there are no out-of-range integers.

pub fn slice_from_int(raw: &[u8]) -> &[u7]

Cast a slice of raw integers to a slice of restricted integers.

The slice is truncated up to the first out-of-range integer, if there is any.

pub unsafe fn slice_from_int_unchecked(raw: &[u8]) -> &[u7]

Cast a slice of raw integers to a slice of restricted integers.

Safety

The input slice must not contain any out-of-range integers.

pub fn slice_try_from_int_mut(raw: &mut [u8]) -> Option<&mut [u7]>

Cast a slice of mutable raw integers to a slice of mutable restricted integers, only if there are no out-of-range integers.

pub fn slice_from_int_mut(raw: &mut [u8]) -> &mut [u7]

Cast a slice of mutable raw integers to a slice of mutable restricted integers.

The slice is truncated up to the first out-of-range integer, if there is any.

pub unsafe fn slice_from_int_unchecked_mut(raw: &mut [u8]) -> &mut [u7]

Cast a slice of mutable raw integers to a slice of mutable restricted integers.

Safety

The input slice must not contain any out-of-range integers.

pub fn slice_as_int(slice: &[u7]) -> &[u8]

Cast a slice of restricted integers to the corresponding raw integers.

All integers are guaranteed to be within range of the restricted int.

Trait Implementations

impl Add<u7> for u7

type Output = u7

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u7> for u7

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for u7

fn clone(&self) -> u7

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for u7

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

Formats the value using the given formatter.

impl Default for u7

fn default() -> u7

Returns the “default value” for a type.

impl Display for u7

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

Formats the value using the given formatter.

impl From<u7> for u8

fn from(restricted: u7) -> u8

Converts to this type from the input type.

impl From<u8> for u7

fn from(raw: u8) -> u7

Lossy convertion, loses top bit.

impl Hash for u7

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 u7

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<u7> for u7

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u7> for u8

fn eq(&self, rhs: &u7) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u8> for u7

fn eq(&self, rhs: &u8) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<u7> for u7

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u7> for u8

fn partial_cmp(&self, rhs: &u7) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u8> for u7

fn partial_cmp(&self, rhs: &u8) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<u7> for u7

type Output = u7

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<u7> for u7

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for u7

impl Eq for u7

impl StructuralEq for u7

impl StructuralPartialEq for u7