Struct NonXIsize

pub struct NonXIsize<const FORBIDDEN: isize> { /* private fields */ }

A number whose value is guaranteed not to be FORBIDDEN.

x is stored as NonZero(x.wrapping_sub(FORBIDDEN)), so transmuting results in wrong values.

Implementations

impl<const FORBIDDEN: isize> NonXIsize<FORBIDDEN>

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

Construct Self, returning None if n is the FORBIDDEN value.

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

Constructs Self without checking whether or not it is only 1s.

Safety

Calling this with the illegal value may result in undefined behaviour.

pub const fn get(self) -> isize

Get the inner value.

Trait Implementations

impl<const FORBIDDEN: isize> Clone for NonXIsize<FORBIDDEN>

fn clone(&self) -> NonXIsize<FORBIDDEN>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const FORBIDDEN: isize> From<NonXIsize<FORBIDDEN>> for isize

fn from(value: NonXIsize<FORBIDDEN>) -> Self

Converts to this type from the input type.

impl<const FORBIDDEN: isize> Hash for NonXIsize<FORBIDDEN>

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 FORBIDDEN: isize> IStable for NonXIsize<FORBIDDEN>

const ID: u64 = 11_460_796_473_375_481_083u64

A stable (and ideally unique) identifier for the type. Often generated using crate::report::gen_id, but can be manually set.

const REPORT: &'static TypeReport

A compile-time generated report of the fields of the type, allowing for compatibility inspection.

type Size = <NonZero<isize> as IStable>::Size

The size of the annotated type in bytes.

type Align = <NonZero<isize> as IStable>::Align

The alignment of the annotated type in bytes.

type ForbiddenValues = <NonZero<isize> as IStable>::ForbiddenValues

The values that the annotated type cannot occupy.

type UnusedBits = <NonZero<isize> as IStable>::UnusedBits

The padding bits in the annotated types

type HasExactlyOneNiche = <NonZero<isize> as IStable>::HasExactlyOneNiche

Allows the detection of whether or not core::option::Options are stable:

type ContainsIndirections = <NonZero<isize> as IStable>::ContainsIndirections

Whether or not the type contains indirections (pointers, indices in independent data-structures…)

fn size() -> usize

Returns the size of the type.

fn align() -> usize

Returns the alignment of the type.

unsafe fn is_invalid(ptr: *const u8) -> bool

Returns true if ptr points to memory that cannot be a valid value of Self.

impl<const FORBIDDEN: isize> Ord for NonXIsize<FORBIDDEN>

fn cmp(&self, other: &Self) -> 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 FORBIDDEN: isize> PartialEq for NonXIsize<FORBIDDEN>

fn eq(&self, other: &NonXIsize<FORBIDDEN>) -> 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 FORBIDDEN: isize> PartialOrd for NonXIsize<FORBIDDEN>

fn partial_cmp(&self, other: &Self) -> 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 FORBIDDEN: isize> TryFrom<isize> for NonXIsize<FORBIDDEN>

type Error = IllegalValue

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl<const FORBIDDEN: isize> Copy for NonXIsize<FORBIDDEN>

impl<const FORBIDDEN: isize> Eq for NonXIsize<FORBIDDEN>

impl<const FORBIDDEN: isize> StructuralPartialEq for NonXIsize<FORBIDDEN>