[][src]Struct nonminmax::NonMinU8

#[repr(transparent)]
pub struct NonMinU8 { /* fields omitted */ }

An integer of type u8 which is known to not equal u8::MIN.

This type allows for niche filling optimization (similar to the existing std::num::NonZero* types) meaning items such as Option<NonMinU8> and Result<NonMinU8, ()> take up the same amount of space as u8.

// Create using `new`, extract value using `get`
let x = NonMinU8::new(123).unwrap();
assert_eq!(x.get(), 123);

// The value cannot be `u8::MIN`
let y = NonMinU8::new(u8::MIN);
assert_eq!(y, None);

// Niche filling optimization works!
use std::mem::size_of;
assert_eq!(size_of::<u8>(), size_of::<NonMinU8>());
assert_eq!(size_of::<u8>(), size_of::<Option<NonMinU8>>());

Methods

impl NonMinU8[src]

pub fn new(value: u8) -> Option<Self>[src]

Creates an instance of NonMinU8 by checking if the value is not u8::MIN.

pub unsafe fn new_unchecked(value: u8) -> Self[src]

Creates an instance of NonMinU8 without checking if the value is not u8::MIN.

Safety

The value cannot be equal to u8::MIN.

pub fn get(self) -> u8[src]

Returns the integer value.

Trait Implementations

impl Clone for NonMinU8[src]

impl Copy for NonMinU8[src]

impl Debug for NonMinU8[src]

impl Display for NonMinU8[src]

impl Eq for NonMinU8[src]

impl From<NonMinU8> for u8[src]

impl Hash for NonMinU8[src]

impl Ord for NonMinU8[src]

impl PartialEq<NonMinU8> for NonMinU8[src]

impl PartialOrd<NonMinU8> for NonMinU8[src]

impl StructuralEq for NonMinU8[src]

impl StructuralPartialEq for NonMinU8[src]

Auto Trait Implementations

impl Send for NonMinU8

impl Sync for NonMinU8

impl Unpin for NonMinU8

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.