Struct Length

pub struct Length { /* private fields */ }

Represents length used by osom_tools.

Notes

Unlike std, Length has i32 as the underlying type. Thus it can handle a lot less items than usize on 64-bit platforms.

But it takes less space in memory, which ultimately is more useful.

Implementations

impl Length

pub const MAX: usize = 2_147_482_623usize

pub const ZERO: Self

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

Tries to convert a usize to a Length.

Errors

For details see LengthError.

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

Tries to convert a i32 to a Length.

Errors

For details see LengthError.

pub const unsafe fn new_unchecked(len: i32) -> Self

Creates a new Length from a i32.

Safety

The len must be non-negative otherwise the behavior is undefined.

pub const fn value(&self) -> i32

Returns the value of the Length.

pub const fn inc(&mut self, value: i32)

Increments the value of the Length by the given value.

pub const fn dec(&mut self, value: i32)

Decrements the value of the Length by the given value.

Trait Implementations

impl Clone for Length

fn clone(&self) -> Length

Returns a duplicate of the value.

const 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 From<Length> for i32

fn from(value: Length) -> Self

Converts to this type from the input type.

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 ==.

const 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 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<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