Struct PositiveIsize 

#[repr(C, align(8))]
pub struct PositiveIsize { /* private fields */ }

A signed value that is known to be positive.

This enables some memory layout optimization. For example, Option<PositiveIsize> is the same size as isize.

Implementations

impl PositiveIsize

pub const BITS: u32 = 64u32

The size of this positive integer type in bits.

This value is equal to isize::BITS.

pub const MIN: Self

The smallest value that can be represented by this positive integer type, 0.

pub const MAX: Self

The largest value that can be represented by this positive integer type, equal to isize::MAX.

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

Creates a PositiveIsize if the given value is positive.

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

Creates a PositiveIsize without checking whether the value is positive. This results in undefined behaviour if the value is negative.

Safety

The value must not be negative.

pub const fn get(self) -> isize

Returns the contained value as a primitive type.

pub const fn count_zeros(self) -> u32

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

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

pub const fn leading_zeros(self) -> u32

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

pub const fn trailing_zeros(self) -> u32

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

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == (1 << k) for some k.

pub const fn ilog2(self) -> u32

Returns the base 2 logarithm of the number, rounded down.

Panics

This function will panic if self is zero.

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

Panics

This function will panic if self is zero.

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

Checked negation. Computes -self, returning None if self == 0.

pub const fn checked_add(self, rhs: Self) -> Option<Self>

Checked addition. Adds a positive integer to another positive integer. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to a negative integer.

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

Checked subtraction. Subtracts a positive integer from another positive integer. Returns None if the result would overflow into a negative integer.

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

Checked multiplication. Multiplies a positive integer by another positive integer, returning a positive result. Returns None if the result would overflow.

pub const fn checked_div(self, rhs: Self) -> Option<Self>

Checked division. Divides a positive integer by another positive integer, returning the positive quotient. Returns None if rhs == 0.

pub const fn checked_rem(self, rhs: Self) -> Option<Self>

Checked remainder. Divides a positive integer by another positive integer, returning the positive remainder. Returns None if rhs == 0.

pub const fn checked_div_unsigned(self, rhs: usize) -> Option<Self>

Checked division by unsigned. Divides a positive integer by an unsigned integer, returning the positive quotient. Returns None if rhs == 0.

pub const fn checked_rem_unsigned(self, rhs: usize) -> Option<Self>

Checked remainder of unsigned. Divides a positive integer by an unsigned integer, returning the positive remainder. Returns None if rhs == 0.

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

Checked integer exponentiation. Raises positive value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to a negative integer.

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

Returns the smallest power of two greater than or equal to self. Checks for overflow and returns None if the next power of two is greater than the type’s maximum value. As a consequence, the result cannot wrap to a negative integer.

pub const fn checked_ilog2(self) -> Option<u32>

Returns the base 2 logarithm of the number, rounded down.

Returns None if the number is zero.

pub const fn checked_ilog10(self) -> Option<u32>

Returns the base 10 logarithm of the number, rounded down.

Returns None if the number is zero.

pub const fn saturating_add(self, rhs: Self) -> Self

Saturating addition. Adds a positive integer to another positive integer. Returns PositiveIsize::MAX on overflow.

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction. Subtracts a positive integer from another positive integer. Returns 0 if the result would overflow into a negative integer.

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

Saturating multiplication. Multiplies a positive integer by another positive integer, returning a positive result. Returns PositiveIsize::MAX on overflow.

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

Saturating integer exponentiation. Raises positive value to an integer power. Returns PositiveIsize::MAX on overflow.

Trait Implementations

impl Binary for PositiveIsize

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

Formats the value using the given formatter.

impl BitAnd<NegativeIsize> for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<PositiveIsize> for NegativeIsize

type Output = PositiveIsize

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<PositiveIsize> for isize

type Output = PositiveIsize

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<isize> for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<NegativeIsize> for PositiveIsize

fn bitand_assign(&mut self, rhs: NegativeIsize)

Performs the &= operation.

impl BitAndAssign<isize> for PositiveIsize

fn bitand_assign(&mut self, rhs: isize)

Performs the &= operation.

impl BitAndAssign for PositiveIsize

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<NegativeIsize> for PositiveIsize

type Output = NegativeIsize

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<PositiveIsize> for NegativeIsize

type Output = NegativeIsize

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<PositiveIsize> for NegativeIsize

fn bitor_assign(&mut self, rhs: PositiveIsize)

Performs the |= operation.

impl BitOrAssign for PositiveIsize

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<NegativeIsize> for PositiveIsize

type Output = NegativeIsize

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<PositiveIsize> for NegativeIsize

type Output = NegativeIsize

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<PositiveIsize> for NegativeIsize

fn bitxor_assign(&mut self, rhs: PositiveIsize)

Performs the ^= operation.

impl BitXorAssign for PositiveIsize

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for PositiveIsize

fn clone(&self) -> PositiveIsize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositiveIsize

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

Formats the value using the given formatter.

impl Default for PositiveIsize

fn default() -> Self

Returns the “default value” for a type.

impl Display for PositiveIsize

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

Formats the value using the given formatter.

impl Div<usize> for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<usize> for PositiveIsize

fn div_assign(&mut self, rhs: usize)

Performs the /= operation.

impl DivAssign for PositiveIsize

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<PositiveI16> for PositiveIsize

fn from(value: PositiveI16) -> Self

Converts to this type from the input type.

impl From<PositiveI8> for PositiveIsize

fn from(value: PositiveI8) -> Self

Converts to this type from the input type.

impl From<PositiveIsize> for isize

fn from(value: PositiveIsize) -> Self

Converts to this type from the input type.

impl From<PositiveIsize> for usize

fn from(value: PositiveIsize) -> Self

Converts to this type from the input type.

impl From<u8> for PositiveIsize

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromStr for PositiveIsize

type Err = IntErrorKind

The associated error which can be returned from parsing.

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

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

impl Hash for PositiveIsize

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 LowerHex for PositiveIsize

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

Formats the value using the given formatter.

impl Not for PositiveIsize

type Output = NegativeIsize

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for PositiveIsize

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

Formats the value using the given formatter.

impl Ord for PositiveIsize

fn cmp(&self, rhs: &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 PartialEq for PositiveIsize

fn eq(&self, rhs: &Self) -> 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 PositiveIsize

fn partial_cmp(&self, rhs: &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 Rem<usize> for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for PositiveIsize

type Output = PositiveIsize

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<usize> for PositiveIsize

fn rem_assign(&mut self, rhs: usize)

Performs the %= operation.

impl RemAssign for PositiveIsize

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl TryFrom<PositiveI32> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveI64> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for PositiveI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for PositiveI8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for i128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for i16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for i32

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for i64

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for i8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for u128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for u16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for u32

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for u64

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PositiveIsize> for u8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i128> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i16> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i32> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i64> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i8> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<isize> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u128> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u16> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u32> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u64> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<usize> for PositiveIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperHex for PositiveIsize

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

Formats the value using the given formatter.

impl Copy for PositiveIsize

impl Eq for PositiveIsize