Struct ByteSize

pub struct ByteSize(u64);

Struct for postgres compatible size units which is different from bytesize::ByteSize. Instead of MiB or GiB and so on, it uses MB, GB for the sizes with 1024 multiplier. Valid units are B, kB, MB, GB, TB with multiples of 1024 where 1MB = 1024kB.

In postgres, each setting has a base unit (for eg. B, kB) and the value can either be integer or float. The base unit serves as the default unit if a number is provided without a unit and it’s also the minimum unit in which values can be rounded to. For example, with base unit of kB, 30.1kB will be rounded to 30kB since it can’t have a lower unit, but 30.1MB will be rounded to 30822kB. For ByteSize, the value is an integer and the base unit is bytes (B).

Tuple Fields

0: u64

Implementations

impl ByteSize

pub const fn b(size: u64) -> ByteSize

pub const fn kb(size: u64) -> ByteSize

pub const fn mb(size: u64) -> ByteSize

pub const fn gb(size: u64) -> ByteSize

pub const fn tb(size: u64) -> ByteSize

pub fn as_bytes(&self) -> u64

fn format_string(&self) -> String

Trait Implementations

impl Arbitrary for ByteSize

type Parameters = <u64 as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<u64 as Arbitrary>::Strategy, fn(u64) -> ByteSize>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for ByteSize

fn clone(&self) -> ByteSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteSize

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

Formats the value using the given formatter.

impl Default for ByteSize

fn default() -> ByteSize

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ByteSize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ByteSize

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

Formats the value using the given formatter.

impl FromStr for ByteSize

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ByteSize

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 ByteSize

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ByteSize

impl StructuralPartialEq for ByteSize