Struct bigbit::linkedbytes::LBNumRef

pub struct LBNumRef<'a>(_);

A borrowed Linked Bytes number, providing access to the data as a number while not owning it.

The borrow checker ensures that the inner data will never be an invalid LB sequence, meaning that after the TryFrom check has passed, there's no way that any external code will tamper the borrowed slice.

Implementations

impl<'a> LBNumRef<'a>

pub const unsafe fn new_unchecked(op: &'a [LinkedByte]) -> Self

Constructs an LBNumRef referring to the specified Linked Byte slice.

Safety

The sequence must be a valid Linked Bytes number.

pub const fn len(self) -> usize

Returns the number of bytes in the number.

pub const fn is_empty(self) -> bool

Returns true if the number is 0, false otherwise.

pub fn iter_le(
    self
) -> impl Iterator<Item = LinkedByte> + DoubleEndedIterator + 'a

Returns a by-value iterator over the linked bytes, in little endian byte order.

pub fn iter_be(
    self
) -> impl Iterator<Item = LinkedByte> + DoubleEndedIterator + 'a

Returns a by-value iterator over the linked bytes, in big endian byte order.

pub fn into_owned(self) -> LBNum

Converts an LBNumRef into an owned LBNumRef. This dereferences and clones the contents.

pub const fn inner(self) -> &'a [LinkedByte]

Returns the inner Linked Byte buffer.

Trait Implementations

impl<'_> Add<LBNumRef<'_>> for LBNum

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: LBNumRef) -> Self

Performs the + operation.

impl<'_> AddAssign<LBNumRef<'_>> for LBNum

fn add_assign(&mut self, rhs: LBNumRef)

Performs the += operation.

impl<'a> Clone for LBNumRef<'a>

fn clone(&self) -> LBNumRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for LBNumRef<'a>

impl<'a> Debug for LBNumRef<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for LBNumRef<'a>

type Target = [LinkedByte]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> DivRemAssign<LBNumRef<'_>> for LBNum

type Remainder = Self

The type for the remainder.

fn div_rem_assign(&mut self, rhs: LBNumRef) -> Self

Performs in-place integer division combined with returning the remainder.

Panics

Dividing by 0 triggers an immediate panic.

impl<'_> Eq for LBNumRef<'_>

impl<'a> From<&'a LBNum> for LBNumRef<'a>

fn from(op: &'a LBNum) -> Self

Performs the conversion.

impl<'a> Ord for LBNumRef<'a>

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_> PartialEq<LBNum> for LBNumRef<'_>

fn eq(&self, rhs: &LBNum) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for LBNumRef<'_>

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for LBNum

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for u8

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for u16

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for u32

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for u64

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for u128

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LBNumRef<'_>> for usize

fn eq(&self, rhs: &LBNumRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<u128> for LBNumRef<'_>

fn eq(&self, rhs: &u128) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<u16> for LBNumRef<'_>

fn eq(&self, rhs: &u16) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<u32> for LBNumRef<'_>

fn eq(&self, rhs: &u32) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<u64> for LBNumRef<'_>

fn eq(&self, rhs: &u64) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<u8> for LBNumRef<'_>

fn eq(&self, rhs: &u8) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<usize> for LBNumRef<'_>

fn eq(&self, rhs: &usize) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialOrd<LBNum> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &LBNum) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for LBNum

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for u8

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for u16

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for u32

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for u64

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for u128

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<LBNumRef<'_>> for usize

fn partial_cmp(&self, rhs: &LBNumRef) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<u128> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &u128) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<u16> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &u16) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<u32> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &u32) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<u64> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &u64) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<u8> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &u8) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'_> PartialOrd<usize> for LBNumRef<'_>

fn partial_cmp(&self, rhs: &usize) -> Option<Ordering>

Compares self and rhs.

Never fails, a return value of Some can be relied upon.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<'a> TryFrom<&'a [LinkedByte]> for LBNumRef<'a>

type Error = InvalidLBSequence

The type returned in the event of a conversion error.

fn try_from(op: &'a [LinkedByte]) -> Result<Self, InvalidLBSequence>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for u8

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for u16

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for isize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for i16

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for u32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for i32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for u64

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for i64

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for u128

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for i128

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.

impl<'a> TryFrom<LBNumRef<'a>> for usize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(op: LBNumRef<'a>) -> Result<Self, TryFromIntError>

Performs the conversion.