Struct Length 

pub struct Length { /* private fields */ }

Represents length internally used by osom tools. Unlike Rust usize type, the Length type is a thin wrapper around u32. In particular it is 32-bit on 64-bit machines. While limiting, the osom libs won’t be using such big arrays anyway. And it saves us space.

Implementations

impl Length

pub const SAFE_MARGIN: u32 = 2048

The amount of bytes one can store safely in a buffer, without exceeding u32 range. In other words Length::MAX_LENGTH plus Length::SAFE_MARGIN is guaranteed to never exceed u32::MAX.

This can be useful if one wants to store some additional data in a buffer whose length is represented by Length.

pub const MAX_LENGTH: Self

The maximal value Length can take. Basically this is i32::MAX - Self::SAFE_MARGIN.

pub const ZERO: Self

Represents Length zero.

pub const ONE: Self

Represents Length one.

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

Creates a new Length out of u32.

Safety

This function does not validate value. It is up to the caller to ensure that its value is below or equal to Length::MAX_LENGTH.

pub const fn try_from_u32(value: u32) -> Result<Self, LengthError>

Creates a new Length from u32.

Errors

For details see LengthError.

pub const fn try_from_usize(value: usize) -> Result<Self, LengthError>

Creates a new Length from usize.

Errors

For details see LengthError.

pub const fn try_from_i32(value: i32) -> Result<Self, LengthError>

Creates a new Length from i32.

Errors

For details see LengthError.

pub const fn as_u32(&self) -> u32

Turns the Length into u32.

pub const fn as_usize(&self) -> usize

Turns the Length into usize.

Trait Implementations

impl<T: AsI32> Add<T> for Length

type Output = Length

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: AsI32> AddAssign<T> for Length

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Length

fn clone(&self) -> Length

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Length

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

Formats the value using the given formatter.

impl Default for Length

fn default() -> Length

Returns the “default value” for a type.

impl Display for Length

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

Formats the value using the given formatter.

impl From<Length> for u32

fn from(value: Length) -> Self

Converts to this type from the input type.

impl From<Length> for usize

fn from(value: Length) -> Self

Converts to this type from the input type.

impl Hash for Length

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 Ord for Length

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

fn eq(&self, other: &Length) -> 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 Length

fn partial_cmp(&self, other: &Length) -> 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 ReprC for Length

const CHECK: () = ()

This field is used for const checks only.

impl<T: AsI32> Sub<T> for Length

type Output = Length

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: AsI32> SubAssign<T> for Length

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<i32> for Length

type Error = LengthError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u32> for Length

type Error = LengthError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<usize> for Length

type Error = LengthError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Length

impl Eq for Length

impl StructuralPartialEq for Length