Struct NonNI8 

pub struct NonNI8<const N: i8>(/* private fields */);

8-bit signed integer type that is known not to equal to any single value N.

This enables some memory layout optimization. For example, Option<NonNI8<N>> is the same size as i8:

use std::mem::size_of;
assert_eq!(size_of::<Option<NonNI8<42>>>(), size_of::<i8>());

Layout

NonNI8\<N> is guaranteed to have the same layout and bit validity as i8 with the exception that N is not a valid instance. Option<NonNI8> is guaranteed to be compatible with i8, including in FFI.

Note that this does not mean you can transmute this type to get a i8 of the same value. If you need an i8 of the same value, use NonNI8::get instead.

Implementations

impl<const N: i8> NonNI8<N>

pub const MIN: Self

The smallest value that can be represented by this non-N integer type.

pub const MAX: Self

The largest value that can be represented by this non-N integer type.

pub const BITS: u32 = 8u32

The size of this non-N integer type in bits.

This value is equal to i8::BITS.

Examples

assert_eq!(NonNI8::<42>::BITS, i8::BITS);

pub const fn new(n: i8) -> Option<Self>

Creates a non-N if the given value is not N.

pub const unsafe fn new_unchecked(n: i8) -> Self

Creates a NonNI8<N> without checking whether the value is non-N. This results in undefined behaviour if the value is N.

Safety

The value must not be N.

pub const fn get(self) -> i8

Returns the value as a primitive type.

pub const fn cast<const M: i8>(self) -> Option<NonNI8<M>>

Returns a new NonNI8<M> with the current value if it is not M.

pub const unsafe fn cast_unchecked<const M: i8>(self) -> NonNI8<M>

Returns a new NonNI8<M> with the current value without checking whether it is not M. This results in undefined behaviour if the current value is M.

Safety

The current value must not be M.

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

Examples

Basic usage:

let n = NonNI8::<42>::new(-1i8).unwrap();

assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

Examples

Basic usage:

let n = NonNI8::<42>::new(0b0101000).unwrap();

assert_eq!(n.trailing_zeros(), 3);

pub const fn checked_mul(self, other: Self) -> Option<Self>

Multiplies two non-N integers together. Checks for overflow and returns None on overflow.

Examples

let two = NonNI8::<42>::new(2).unwrap();
let four = NonNI8::<42>::new(4).unwrap();
let max = NonNI8::<42>::new(i8::MAX).unwrap();

assert_eq!(Some(four), two.checked_mul(two));
assert_eq!(None, max.checked_mul(two));

pub const fn saturating_mul(self, other: Self) -> Self

Multiplies two non-N integers together. Return NonNI8::<42>::MAX on overflow.

Examples

let two = NonNI8::<42>::new(2)?;
let four = NonNI8::<42>::new(4)?;
let max = NonNI8::<42>::new(i8::MAX)?;

assert_eq!(four, two.saturating_mul(two));
assert_eq!(max, four.saturating_mul(max));

pub const fn checked_pow(self, other: u32) -> Option<Self>

Multiplies two non-N integers together, assuming overflow cannot occur. Overflow is unchecked, and it is undefined behaviour to overflow even if the result would wrap to a non-N value. The behaviour is undefined as soon as self * rhs > i8::MAX, or self * rhs < i8::MIN. Raises non-N value to an integer power. Checks for overflow and returns None on overflow.

Examples

let three = NonNI8::<42>::new(3)?;
let twenty_seven = NonNI8::<42>::new(27)?;
let half_max = NonNI8::<42>::new(i8::MAX / 2)?;

assert_eq!(Some(twenty_seven), three.checked_pow(3));
assert_eq!(None, half_max.checked_pow(3));

pub const fn saturating_pow(self, other: u32) -> Self

Raise non-N value to an integer power. Return NonNI8::<42>::MIN or NonNI8::<42>::MAX on overflow.

Examples

let three = NonNI8::<42>::new(3)?;
let twenty_seven = NonNI8::<42>::new(27)?;
let max = NonNI8::<42>::new(i8::MAX)?;

assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));

pub const fn abs(self) -> Self

Computes the absolute value of self. See i8::abs for documentation on overflow behaviour.

Example

let pos = NonNI8::<42>::new(1)?;
let neg = NonNI8::<42>::new(-1)?;

assert_eq!(pos, pos.abs());
assert_eq!(pos, neg.abs());

pub const fn checked_abs(self) -> Option<Self>

Checked absolute value. Checks for overflow and returns None if self == NonNI8::MIN. The result cannot be N.

Example

let pos = NonNI8::<42>::new(1)?;
let neg = NonNI8::<42>::new(-1)?;
let min = NonNI8::<42>::new(i8::MIN)?;

assert_eq!(Some(pos), neg.checked_abs());
assert_eq!(None, min.checked_abs());

pub const fn overflowing_abs(self) -> (Self, bool)

Computes the absolute value of self, with overflow information, see i8::overflowing_abs.

Example

let pos = NonNI8::<42>::new(1)?;
let neg = NonNI8::<42>::new(-1)?;
let min = NonNI8::<42>::new(i8::MIN)?;

assert_eq!((pos, false), pos.overflowing_abs());
assert_eq!((pos, false), neg.overflowing_abs());
assert_eq!((min, true), min.overflowing_abs());

pub const fn saturating_abs(self) -> Self

Saturating absolute value, see i8::saturating_abs.

Example

let pos = NonNI8::<42>::new(1)?;
let neg = NonNI8::<42>::new(-1)?;
let min = NonNI8::<42>::new(i8::MIN)?;
let min_plus = NonNI8::<42>::new(i8::MIN + 1)?;
let max = NonNI8::<42>::new(i8::MAX)?;

assert_eq!(pos, pos.saturating_abs());
assert_eq!(pos, neg.saturating_abs());
assert_eq!(max, min.saturating_abs());
assert_eq!(max, min_plus.saturating_abs());

pub const fn wrapping_abs(self) -> Self

Wrapping absolute value, see i8::wrapping_abs.

Example

let pos = NonNI8::<42>::new(1)?;
let neg = NonNI8::<42>::new(-1)?;
let min = NonNI8::<42>::new(i8::MIN)?;

assert_eq!(pos, pos.wrapping_abs());
assert_eq!(pos, neg.wrapping_abs());
assert_eq!(min, min.wrapping_abs());

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is negative.

Example

let pos_five = NonNI8::<42>::new(5).unwrap();
let neg_five = NonNI8::<42>::new(-5).unwrap();

assert!(pos_five.is_positive());
assert!(!neg_five.is_positive());

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is positive.

Example

let pos_five = NonNI8::<42>::new(5)?;
let neg_five = NonNI8::<42>::new(-5)?;

assert!(neg_five.is_negative());
assert!(!pos_five.is_negative());

pub const fn checked_neg(self) -> Option<Self>

Checked negation. Computes -self, returning None if self == NonNI8::MIN.

Example

let pos_five = NonNI8::<42>::new(5)?;
let neg_five = NonNI8::<42>::new(-5)?;
let min = NonNI8::<42>::new(i8::MIN)?;

assert_eq!(pos_five.checked_neg(), Some(neg_five));
assert_eq!(min.checked_neg(), None);

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

See i8::overflowing_neg for documentation on overflow behaviour.

Example

let pos_five = NonNI8::<42>::new(5)?;
let neg_five = NonNI8::<42>::new(-5)?;
let min = NonNI8::<42>::new(i8::MIN)?;

assert_eq!(pos_five.overflowing_neg(), (neg_five, false));
assert_eq!(min.overflowing_neg(), (min, true));

pub const fn saturating_neg(self) -> Self

Saturating negation. Computes -self, returning NonNI8::<42>::MAX if self == NonNI8::<42>::MIN instead of overflowing.

Example

let pos_five = NonNI8::<42>::new(5)?;
let neg_five = NonNI8::<42>::new(-5)?;
let min = NonNI8::<42>::new(i8::MIN)?;
let min_plus_one = NonNI8::<42>::new(i8::MIN + 1)?;
let max = NonNI8::<42>::new(i8::MAX)?;

assert_eq!(pos_five.saturating_neg(), neg_five);
assert_eq!(min.saturating_neg(), max);
assert_eq!(max.saturating_neg(), min_plus_one);

pub const fn wrapping_neg(self) -> Self

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

See i8::wrapping_neg for documentation on overflow behaviour.

Example

let pos_five = NonNI8::<42>::new(5)?;
let neg_five = NonNI8::<42>::new(-5)?;
let min = NonNI8::<42>::new(i8::MIN)?;

assert_eq!(pos_five.wrapping_neg(), neg_five);
assert_eq!(min.wrapping_neg(), min);

Trait Implementations

impl<const N: i8, const M: i8> Add<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the + operator.

fn add(self, rhs: NonNI8<M>) -> Self::Output

Performs the + operation.

impl<const N: i8> Add<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the + operator.

fn add(self, rhs: i8) -> Self::Output

Performs the + operation.

impl<const N: i8, const M: i8> AddAssign<NonNI8<M>> for NonNI8<N>

fn add_assign(&mut self, rhs: NonNI8<M>)

Performs the += operation.

impl<const N: i8> AddAssign<i8> for NonNI8<N>

fn add_assign(&mut self, rhs: i8)

Performs the += operation.

impl<const N: i8> Binary for NonNI8<N>

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

Formats the value using the given formatter.

impl<const N: i8, const M: i8> BitAnd<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: NonNI8<M>) -> Self::Output

Performs the & operation.

impl<const N: i8> BitAnd<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const N: i8, const M: i8> BitAndAssign<NonNI8<M>> for NonNI8<N>

fn bitand_assign(&mut self, rhs: NonNI8<M>)

Performs the &= operation.

impl<const N: i8> BitAndAssign<i8> for NonNI8<N>

fn bitand_assign(&mut self, rhs: i8)

Performs the &= operation.

impl<const N: i8, const M: i8> BitOr<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: NonNI8<M>) -> Self::Output

Performs the | operation.

impl<const N: i8> BitOr<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const N: i8, const M: i8> BitOrAssign<NonNI8<M>> for NonNI8<N>

fn bitor_assign(&mut self, rhs: NonNI8<M>)

Performs the |= operation.

impl<const N: i8> BitOrAssign<i8> for NonNI8<N>

fn bitor_assign(&mut self, rhs: i8)

Performs the |= operation.

impl<const N: i8, const M: i8> BitXor<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: NonNI8<M>) -> Self::Output

Performs the ^ operation.

impl<const N: i8> BitXor<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const N: i8, const M: i8> BitXorAssign<NonNI8<M>> for NonNI8<N>

fn bitxor_assign(&mut self, rhs: NonNI8<M>)

Performs the ^= operation.

impl<const N: i8> BitXorAssign<i8> for NonNI8<N>

fn bitxor_assign(&mut self, rhs: i8)

Performs the ^= operation.

impl<const N: i8> Clone for NonNI8<N>

fn clone(&self) -> NonNI8<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: i8> Debug for NonNI8<N>

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

Formats the value using the given formatter.

impl<const N: i8> Display for NonNI8<N>

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

Formats the value using the given formatter.

impl<const N: i8, const M: i8> Div<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the / operator.

fn div(self, rhs: NonNI8<M>) -> Self::Output

Performs the / operation.

impl<const N: i8> Div<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the / operator.

fn div(self, rhs: i8) -> Self::Output

Performs the / operation.

impl<const N: i8, const M: i8> DivAssign<NonNI8<M>> for NonNI8<N>

fn div_assign(&mut self, rhs: NonNI8<M>)

Performs the /= operation.

impl<const N: i8> DivAssign<i8> for NonNI8<N>

fn div_assign(&mut self, rhs: i8)

Performs the /= operation.

impl<const N: i8> From<NonNI8<N>> for i8

fn from(nonn: NonNI8<N>) -> Self

Converts a NonNI8 into an i8

impl<const N: i8> FromStr for NonNI8<N>

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const N: i8> Hash for NonNI8<N>

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<const N: i8> LowerHex for NonNI8<N>

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

Formats the value using the given formatter.

impl<const N: i8, const M: i8> Mul<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the * operator.

fn mul(self, rhs: NonNI8<M>) -> Self::Output

Performs the * operation.

impl<const N: i8> Mul<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the * operator.

fn mul(self, rhs: i8) -> Self::Output

Performs the * operation.

impl<const N: i8, const M: i8> MulAssign<NonNI8<M>> for NonNI8<N>

fn mul_assign(&mut self, rhs: NonNI8<M>)

Performs the *= operation.

impl<const N: i8> MulAssign<i8> for NonNI8<N>

fn mul_assign(&mut self, rhs: i8)

Performs the *= operation.

impl<const N: i8> Not for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const N: i8> Octal for NonNI8<N>

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

Formats the value using the given formatter.

impl<const N: i8> Ord for NonNI8<N>

fn cmp(&self, other: &NonNI8<N>) -> 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<const N: i8> PartialEq for NonNI8<N>

fn eq(&self, other: &NonNI8<N>) -> 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<const N: i8> PartialOrd for NonNI8<N>

fn partial_cmp(&self, other: &NonNI8<N>) -> 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<const N: i8, const M: i8> Rem<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the % operator.

fn rem(self, rhs: NonNI8<M>) -> Self::Output

Performs the % operation.

impl<const N: i8> Rem<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the % operator.

fn rem(self, rhs: i8) -> Self::Output

Performs the % operation.

impl<const N: i8, const M: i8> RemAssign<NonNI8<M>> for NonNI8<N>

fn rem_assign(&mut self, rhs: NonNI8<M>)

Performs the %= operation.

impl<const N: i8> RemAssign<i8> for NonNI8<N>

fn rem_assign(&mut self, rhs: i8)

Performs the %= operation.

impl<const N: i8, const M: i8> Shl<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the << operator.

fn shl(self, rhs: NonNI8<M>) -> Self::Output

Performs the << operation.

impl<const N: i8> Shl<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the << operator.

fn shl(self, rhs: i8) -> Self::Output

Performs the << operation.

impl<const N: i8, const M: i8> ShlAssign<NonNI8<M>> for NonNI8<N>

fn shl_assign(&mut self, rhs: NonNI8<M>)

Performs the <<= operation.

impl<const N: i8> ShlAssign<i8> for NonNI8<N>

fn shl_assign(&mut self, rhs: i8)

Performs the <<= operation.

impl<const N: i8, const M: i8> Shr<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: NonNI8<M>) -> Self::Output

Performs the >> operation.

impl<const N: i8> Shr<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: i8) -> Self::Output

Performs the >> operation.

impl<const N: i8, const M: i8> ShrAssign<NonNI8<M>> for NonNI8<N>

fn shr_assign(&mut self, rhs: NonNI8<M>)

Performs the >>= operation.

impl<const N: i8> ShrAssign<i8> for NonNI8<N>

fn shr_assign(&mut self, rhs: i8)

Performs the >>= operation.

impl<const N: i8, const M: i8> Sub<NonNI8<M>> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the - operator.

fn sub(self, rhs: NonNI8<M>) -> Self::Output

Performs the - operation.

impl<const N: i8> Sub<i8> for NonNI8<N>

type Output = NonNI8<N>

The resulting type after applying the - operator.

fn sub(self, rhs: i8) -> Self::Output

Performs the - operation.

impl<const N: i8, const M: i8> SubAssign<NonNI8<M>> for NonNI8<N>

fn sub_assign(&mut self, rhs: NonNI8<M>)

Performs the -= operation.

impl<const N: i8> SubAssign<i8> for NonNI8<N>

fn sub_assign(&mut self, rhs: i8)

Performs the -= operation.

impl<const N: i8> UpperHex for NonNI8<N>

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

Formats the value using the given formatter.

impl<const N: i8> Copy for NonNI8<N>

impl<const N: i8> Eq for NonNI8<N>

impl<const N: i8> StructuralPartialEq for NonNI8<N>