Struct libspecr::Size

pub struct Size { /* private fields */ }

Size represents a non-negative number of bytes or bits.

It is basically a copy of the Size type in the Rust compiler. See Size.

Note that the Size type has no upper-bound. Users needs check whether a given Size is too large for their Machine themselves.

Implementations

impl Size

pub const ZERO: Size = _

The “0 bytes” size.

pub fn from_bits(bits: impl Into<Int>) -> Option<Size>

Returns None if bits is negative or not divisible by 8.

pub const fn from_bits_const(bits: u64) -> Option<Size>

Variation of from_bits for const contexts. Returns None if bits is not divisible by 8.

pub fn from_bytes(bytes: impl Into<Int>) -> Option<Size>

Returns None if bytes is negative.

pub const fn from_bytes_const(bytes: u64) -> Size

Variation of from_bytes for const contexts. Cannot fail since the input is unsigned and already in bytes.

pub fn bytes(self) -> Int

The number of bytes of self

pub fn bits(self) -> Int

The number of bits of self

pub fn is_zero(&self) -> bool

Returns whether self is Size::ZERO

Trait Implementations

impl Add for Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, rhs: Size) -> Size

Performs the + operation.

impl Clone for Size

fn clone(&self) -> Size

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Size

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

Formats the value using the given formatter.

impl Hash for Size

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 Mul<Int> for Size

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: Int) -> Size

Performs the * operation.

impl Mul<Size> for Int

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: Size) -> Size

Performs the * operation.

impl Ord for Size

fn cmp(&self, other: &Size) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Size

fn eq(&self, other: &Size) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Size

fn partial_cmp(&self, other: &Size) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Copy for Size

impl Eq for Size

impl StructuralPartialEq for Size