Struct Word16 

#[repr(transparent)]
pub struct Word16(pub u16);

A 16-bit wrapping integer: the ring ℤ/2^16ℤ, where every operation is total and wraps modulo 2^16.

Tuple Fields

0: u16

Implementations

impl Word16

pub const BITS: u32 = u16::BITS

Bit width of the ring.

pub const ZERO: Word16

Additive identity.

pub const ONE: Word16

Multiplicative identity.

pub const MAX: Word16

The all-ones value (2^BITS − 1).

pub const fn get(self) -> u16

The underlying primitive value.

pub const fn add(self, o: Word16) -> Word16

Wrapping addition in ℤ/2ᵏ.

pub const fn sub(self, o: Word16) -> Word16

Wrapping subtraction in ℤ/2ᵏ.

pub const fn mul(self, o: Word16) -> Word16

Wrapping multiplication in ℤ/2ᵏ.

pub const fn bitand(self, o: Word16) -> Word16

Bitwise AND.

pub const fn bitor(self, o: Word16) -> Word16

Bitwise OR.

pub const fn bitxor(self, o: Word16) -> Word16

Bitwise XOR.

pub const fn not(self) -> Word16

Bitwise complement.

pub const fn shl(self, n: u32) -> Word16

Logical left shift by n (the count is taken modulo BITS, matching the hardware shift and the language’s shifted left by).

pub const fn shr(self, n: u32) -> Word16

Logical right shift by n (count modulo BITS).

pub const fn rotl(self, n: u32) -> Word16

Left rotation by n — a width-defined bit-permutation (the crypto primitive).

pub const fn rotr(self, n: u32) -> Word16

Right rotation by n.

Trait Implementations

impl Add for Word16

type Output = Word16

The resulting type after applying the + operator.

fn add(self, o: Word16) -> Word16

Performs the + operation.

impl BitAnd for Word16

type Output = Word16

The resulting type after applying the & operator.

fn bitand(self, o: Word16) -> Word16

Performs the & operation.

impl BitOr for Word16

type Output = Word16

The resulting type after applying the | operator.

fn bitor(self, o: Word16) -> Word16

Performs the | operation.

impl BitXor for Word16

type Output = Word16

The resulting type after applying the ^ operator.

fn bitxor(self, o: Word16) -> Word16

Performs the ^ operation.

impl Clone for Word16

fn clone(&self) -> Word16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Word16

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

Formats the value using the given formatter.

impl Display for Word16

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

Formats the value using the given formatter.

impl Div for Word16

type Output = Word16

The resulting type after applying the / operator.

fn div(self, o: Word16) -> Word16

Performs the / operation.

impl Hash for Word16

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 Mul for Word16

type Output = Word16

The resulting type after applying the * operator.

fn mul(self, o: Word16) -> Word16

Performs the * operation.

impl Not for Word16

type Output = Word16

The resulting type after applying the ! operator.

fn not(self) -> Word16

Performs the unary ! operation.

impl Ord for Word16

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

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

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

type Output = Word16

The resulting type after applying the % operator.

fn rem(self, o: Word16) -> Word16

Performs the % operation.

impl Shl<u32> for Word16

type Output = Word16

The resulting type after applying the << operator.

fn shl(self, n: u32) -> Word16

Performs the << operation.

impl Showable for Word16

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

impl Shr<u32> for Word16

type Output = Word16

The resulting type after applying the >> operator.

fn shr(self, n: u32) -> Word16

Performs the >> operation.

impl Sub for Word16

type Output = Word16

The resulting type after applying the - operator.

fn sub(self, o: Word16) -> Word16

Performs the - operation.

impl WordRotate for Word16

fn rotl(self, n: u32) -> Self

fn rotr(self, n: u32) -> Self

impl Copy for Word16

impl Eq for Word16

impl StructuralPartialEq for Word16