Struct Size

pub struct Size(pub u64);

Represents a size in bytes.

This type wraps a u64 to provide type safety and prevent accidental mixing of sizes with other numeric values. It supports basic arithmetic operations and comparison.

Examples

use codeq::Size;

let size = Size(1024);
let doubled = size + size;
assert_eq!(doubled, Size(2048));

// Sizes can be compared
assert!(Size(100) > Size(50));

// Can be created from u64
let size = Size::from(2048u64);

Tuple Fields

0: u64

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Add<Size> for Offset

type Output = Offset

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Size

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Size> for Offset

fn add_assign(&mut self, rhs: Size)

Performs the += operation.

impl AddAssign for Size

fn add_assign(&mut self, rhs: 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 Default for Size

fn default() -> Size

Returns the “default value” for a type.

impl Deref for Size

type Target = u64

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for Size

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

Formats the value using the given formatter.

impl From<u64> for Size

fn from(value: u64) -> Self

Converts to this type from the input type.

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,

Restrict a value to a certain interval.

impl PartialEq for Size

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

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 Sub<Size> for Offset

type Output = Offset

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Size

type Output = Size

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Size> for Offset

fn sub_assign(&mut self, rhs: Size)

Performs the -= operation.

impl SubAssign for Size

fn sub_assign(&mut self, rhs: Size)

Performs the -= operation.

impl Copy for Size

impl Eq for Size

impl StructuralPartialEq for Size