Struct ux::i12

pub struct i12(_);

The 12-bit signed integer type.

Methods

impl i12

The 12-bit signed integer type.

pub const MAX: Self

MAX: Self = i12(((1 as i16) << 12 - 1) - 1)

pub const MIN: Self

MIN: Self = i12(-((1 as i16) << 12 - 1))

impl i12

pub fn min_value() -> i12

Returns the smallest value that can be represented by this integer type.

pub fn max_value() -> i12

Returns the largest value that can be represented by this integer type.

pub fn new(value: i16) -> i12

Crates a new variable

This function mainly exists as there is currently not a better way to construct these types. May be deprecated or removed if a better way to construct these types becomes available.

Examples

Basic usage:

use ux::*;

assert_eq!(u31::new(64), u31::from(64u8));

Panic

This function will panic if value is not representable by this type

pub fn wrapping_sub(self, rhs: Self) -> Self

Wrapping (modular) subtraction. Computes self - other, wrapping around at the boundary of the type.

Examples

Basic usage:

use ux::*;

assert_eq!(i5::MIN.wrapping_sub(i5::new(1)), i5::MAX);

assert_eq!(i5::new(-10).wrapping_sub(i5::new(5)), i5::new(-15));
assert_eq!(i5::new(-15).wrapping_sub(i5::new(5)), i5::new(12));

pub fn wrapping_add(self, rhs: Self) -> Self

Wrapping (modular) addition. Computes self + other, wrapping around at the boundary of the type.

Examples

Basic usage:

use ux::*;

assert_eq!(i5::MAX.wrapping_add(i5::new(1)), i5::MIN);

assert_eq!(i5::new(10).wrapping_add(i5::new(5)), i5::new(15));
assert_eq!(i5::new(15).wrapping_add(i5::new(5)), i5::new(-12));

Trait Implementations

impl From<i8> for i12

fn from(x: i8) -> i12

Performs the conversion.

impl From<i12> for i16

fn from(x: i12) -> i16

Performs the conversion.

impl From<i12> for i32

fn from(x: i12) -> i32

Performs the conversion.

impl From<i12> for i64

fn from(x: i12) -> i64

Performs the conversion.

impl From<i2> for i12

fn from(x: i2) -> i12

Performs the conversion.

impl From<i3> for i12

fn from(x: i3) -> i12

Performs the conversion.

impl From<i4> for i12

fn from(x: i4) -> i12

Performs the conversion.

impl From<i5> for i12

fn from(x: i5) -> i12

Performs the conversion.

impl From<i6> for i12

fn from(x: i6) -> i12

Performs the conversion.

impl From<i7> for i12

fn from(x: i7) -> i12

Performs the conversion.

impl From<i9> for i12

fn from(x: i9) -> i12

Performs the conversion.

impl From<i10> for i12

fn from(x: i10) -> i12

Performs the conversion.

impl From<i11> for i12

fn from(x: i11) -> i12

Performs the conversion.

impl From<i12> for i13

fn from(x: i12) -> i13

Performs the conversion.

impl From<i12> for i14

fn from(x: i12) -> i14

Performs the conversion.

impl From<i12> for i15

fn from(x: i12) -> i15

Performs the conversion.

impl From<i12> for i17

fn from(x: i12) -> i17

Performs the conversion.

impl From<i12> for i18

fn from(x: i12) -> i18

Performs the conversion.

impl From<i12> for i19

fn from(x: i12) -> i19

Performs the conversion.

impl From<i12> for i20

fn from(x: i12) -> i20

Performs the conversion.

impl From<i12> for i21

fn from(x: i12) -> i21

Performs the conversion.

impl From<i12> for i22

fn from(x: i12) -> i22

Performs the conversion.

impl From<i12> for i23

fn from(x: i12) -> i23

Performs the conversion.

impl From<i12> for i24

fn from(x: i12) -> i24

Performs the conversion.

impl From<i12> for i25

fn from(x: i12) -> i25

Performs the conversion.

impl From<i12> for i26

fn from(x: i12) -> i26

Performs the conversion.

impl From<i12> for i27

fn from(x: i12) -> i27

Performs the conversion.

impl From<i12> for i28

fn from(x: i12) -> i28

Performs the conversion.

impl From<i12> for i29

fn from(x: i12) -> i29

Performs the conversion.

impl From<i12> for i30

fn from(x: i12) -> i30

Performs the conversion.

impl From<i12> for i31

fn from(x: i12) -> i31

Performs the conversion.

impl From<i12> for i33

fn from(x: i12) -> i33

Performs the conversion.

impl From<i12> for i34

fn from(x: i12) -> i34

Performs the conversion.

impl From<i12> for i35

fn from(x: i12) -> i35

Performs the conversion.

impl From<i12> for i36

fn from(x: i12) -> i36

Performs the conversion.

impl From<i12> for i37

fn from(x: i12) -> i37

Performs the conversion.

impl From<i12> for i38

fn from(x: i12) -> i38

Performs the conversion.

impl From<i12> for i39

fn from(x: i12) -> i39

Performs the conversion.

impl From<i12> for i40

fn from(x: i12) -> i40

Performs the conversion.

impl From<i12> for i41

fn from(x: i12) -> i41

Performs the conversion.

impl From<i12> for i42

fn from(x: i12) -> i42

Performs the conversion.

impl From<i12> for i43

fn from(x: i12) -> i43

Performs the conversion.

impl From<i12> for i44

fn from(x: i12) -> i44

Performs the conversion.

impl From<i12> for i45

fn from(x: i12) -> i45

Performs the conversion.

impl From<i12> for i46

fn from(x: i12) -> i46

Performs the conversion.

impl From<i12> for i47

fn from(x: i12) -> i47

Performs the conversion.

impl From<i12> for i48

fn from(x: i12) -> i48

Performs the conversion.

impl From<i12> for i49

fn from(x: i12) -> i49

Performs the conversion.

impl From<i12> for i50

fn from(x: i12) -> i50

Performs the conversion.

impl From<i12> for i51

fn from(x: i12) -> i51

Performs the conversion.

impl From<i12> for i52

fn from(x: i12) -> i52

Performs the conversion.

impl From<i12> for i53

fn from(x: i12) -> i53

Performs the conversion.

impl From<i12> for i54

fn from(x: i12) -> i54

Performs the conversion.

impl From<i12> for i55

fn from(x: i12) -> i55

Performs the conversion.

impl From<i12> for i56

fn from(x: i12) -> i56

Performs the conversion.

impl From<i12> for i57

fn from(x: i12) -> i57

Performs the conversion.

impl From<i12> for i58

fn from(x: i12) -> i58

Performs the conversion.

impl From<i12> for i59

fn from(x: i12) -> i59

Performs the conversion.

impl From<i12> for i60

fn from(x: i12) -> i60

Performs the conversion.

impl From<i12> for i61

fn from(x: i12) -> i61

Performs the conversion.

impl From<i12> for i62

fn from(x: i12) -> i62

Performs the conversion.

impl From<i12> for i63

fn from(x: i12) -> i63

Performs the conversion.

impl Default for i12

fn default() -> i12

Returns the "default value" for a type.

impl Clone for i12

fn clone(&self) -> i12

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for i12

impl Debug for i12

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for i12

fn eq(&self, other: &Self) -> 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 !=.

impl Eq for i12

impl PartialOrd for i12

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Hash for i12

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Display for i12

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

Formats the value using the given formatter.

impl UpperHex for i12

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

Formats the value using the given formatter.

impl LowerHex for i12

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

Formats the value using the given formatter.

impl Octal for i12

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

Formats the value using the given formatter.

impl Binary for i12

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

Formats the value using the given formatter.

impl<T> Shr<T> for i12 where
    i16: Shr<T, Output = i16>, 

type Output = i12

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> i12

Performs the >> operation.

impl<T> Shl<T> for i12 where
    i16: Shl<T, Output = i16>, 

type Output = i12

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> i12

Performs the << operation.

impl<T> ShrAssign<T> for i12 where
    i16: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> ShlAssign<T> for i12 where
    i16: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl BitOr<i12> for i12

type Output = i12

The resulting type after applying the | operator.

fn bitor(self, rhs: i12) -> Self::Output

Performs the | operation.

impl<'a> BitOr<&'a i12> for i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a i12) -> Self::Output

Performs the | operation.

impl<'a> BitOr<i12> for &'a i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: i12) -> Self::Output

Performs the | operation.

impl<'a> BitOr<&'a i12> for &'a i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a i12) -> Self::Output

Performs the | operation.

impl BitOrAssign<i12> for i12

fn bitor_assign(&mut self, other: i12)

Performs the |= operation.

impl BitXor<i12> for i12

type Output = i12

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: i12) -> Self::Output

Performs the ^ operation.

impl<'a> BitXor<&'a i12> for i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a i12) -> Self::Output

Performs the ^ operation.

impl<'a> BitXor<i12> for &'a i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: i12) -> Self::Output

Performs the ^ operation.

impl<'a> BitXor<&'a i12> for &'a i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a i12) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<i12> for i12

fn bitxor_assign(&mut self, other: i12)

Performs the ^= operation.

impl Not for i12

type Output = i12

The resulting type after applying the ! operator.

fn not(self) -> i12

Performs the unary ! operation.

impl<'a> Not for &'a i12

type Output = <i12 as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> i12

Performs the unary ! operation.

impl BitAnd<i12> for i12

type Output = i12

The resulting type after applying the & operator.

fn bitand(self, rhs: i12) -> Self::Output

Performs the & operation.

impl<'a> BitAnd<&'a i12> for i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a i12) -> Self::Output

Performs the & operation.

impl<'a> BitAnd<i12> for &'a i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: i12) -> Self::Output

Performs the & operation.

impl<'a> BitAnd<&'a i12> for &'a i12

type Output = <i12 as BitOr<i12>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a i12) -> Self::Output

Performs the & operation.

impl BitAndAssign<i12> for i12

fn bitand_assign(&mut self, other: i12)

Performs the &= operation.

impl Add<i12> for i12

type Output = i12

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<i12> for i12

type Output = i12

The resulting type after applying the - operator.

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

Performs the - operation.