Struct u14 

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

A 14-bit integer type.

Wraps the u16 type and ensures that the top two bits are always zero.

Implementations

impl u14

pub const fn max_value() -> u14

The maximum value that this restricted integer can hold.

pub const fn new(raw: u16) -> u14

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

pub const fn from_int_lossy(raw: u16) -> u14

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

pub fn try_from(raw: u16) -> Option<u14>

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

pub fn as_int(self) -> u16

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: &[u16]) -> Option<&[u14]>

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: &[u16]) -> &[u14]

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: &[u16]) -> &[u14]

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 [u16]) -> Option<&mut [u14]>

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 [u16]) -> &mut [u14]

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 [u16]) -> &mut [u14]

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: &[u14]) -> &[u16]

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 for u14

type Output = u14

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for u14

fn add_assign(&mut self, other: u14)

Performs the += operation.

impl Clone for u14

fn clone(&self) -> u14

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for u14

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

Formats the value using the given formatter.

impl Default for u14

fn default() -> u14

Returns the “default value” for a type.

impl Display for u14

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

Formats the value using the given formatter.

impl From<u16> for u14

fn from(raw: u16) -> u14

Lossy convertion, loses top bit.

impl Hash for u14

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

where __H: Hasher,

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 u14

fn cmp(&self, other: &u14) -> 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<u16> for u14

fn eq(&self, rhs: &u16) -> 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 PartialEq for u14

fn eq(&self, other: &u14) -> 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<u16> for u14

fn partial_cmp(&self, rhs: &u16) -> 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 PartialOrd for u14

fn partial_cmp(&self, other: &u14) -> 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 Sub for u14

type Output = u14

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for u14

fn sub_assign(&mut self, other: u14)

Performs the -= operation.

impl Copy for u14

impl Eq for u14

impl StructuralPartialEq for u14