Struct ParsedQuantity 

pub struct ParsedQuantity { /* private fields */ }

ParsedQuantity represents a parsed Kubernetes quantity.

use k8s_openapi::apimachinery::pkg::api::resource::Quantity;
use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Kubernetes quantity
let k8s_quantity = Quantity("1Ki".to_string());

// Try parsing k8s quantity
let quantity: Result<ParsedQuantity, ParseQuantityError> = k8s_quantity.try_into();

assert_eq!(quantity.unwrap().to_string(), "1Ki");

Implementations

impl ParsedQuantity

pub fn to_string_with_precision(&self, precision: u32) -> String

Returns the value of the quantity as a string with the specified number of decimal points for fractional portion. Additionally it performs normalization, i.e., strips any trailing zero’s from a value and converts -0 to 0.

When a number is halfway between two others, it is rounded toward the nearest number that is away from zero. e.g. 6.4 -> 6, 6.5 -> 7, -6.5 -> -7

use k8s_openapi::apimachinery::pkg::api::resource::Quantity;
use kube_quantity::ParsedQuantity;

let k_quantity: ParsedQuantity = Quantity("1k".to_string()).try_into().unwrap();
let ki_quantity: ParsedQuantity = Quantity("1Ki".to_string()).try_into().unwrap();

let q3 = k_quantity + ki_quantity;

assert_eq!(q3.to_string_with_precision(3), "2.024k");
assert_eq!(q3.to_string_with_precision(2), "2.02k");
assert_eq!(q3.to_string_with_precision(1), "2k");
assert_eq!(q3.to_string_with_precision(0), "2k");

pub fn to_bytes_f64(&self) -> Option<f64>

Returns the value of the quantity as an f64.

use k8s_openapi::apimachinery::pkg::api::resource::Quantity;
use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Kubernetes quantity
let k8s_quantity = Quantity("1Ki".to_string());

// Try parsing k8s quantity
let quantity: Result<ParsedQuantity, ParseQuantityError> = k8s_quantity.try_into();

assert_eq!(quantity.unwrap().to_bytes_f64(), Some(1024.0));

pub fn to_bytes_f32(&self) -> Option<f32>

Returns the value of the quantity as an f32.

pub fn to_bytes_i128(&self) -> Option<i128>

Returns the value of the quantity as an i128.

pub fn to_bytes_i64(&self) -> Option<i64>

Returns the value of the quantity as an i64.

pub fn to_bytes_i32(&self) -> Option<i32>

Returns the value of the quantity as an i32.

pub fn to_bytes_i16(&self) -> Option<i16>

Returns the value of the quantity as an i16.

pub fn to_bytes_i8(&self) -> Option<i8>

Returns the value of the quantity as an i8. This will only work if the scale is 0.

pub fn to_bytes_isize(&self) -> Option<isize>

Returns the value of the quantity as an isize.

pub fn to_bytes_u128(&self) -> Option<u128>

Returns the value of the quantity as an u128.

pub fn to_bytes_u64(&self) -> Option<u64>

Returns the value of the quantity as an u64.

pub fn to_bytes_u32(&self) -> Option<u32>

Returns the value of the quantity as an u32.

pub fn to_bytes_u16(&self) -> Option<u16>

Returns the value of the quantity as an u16.

pub fn to_bytes_u8(&self) -> Option<u8>

Returns the value of the quantity as an u8. This will only work if the scale is 0.

pub fn to_bytes_usize(&self) -> Option<usize>

Returns the value of the quantity as an usize.

Trait Implementations

impl Add for ParsedQuantity

type Output = ParsedQuantity

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for ParsedQuantity

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for ParsedQuantity

fn clone(&self) -> ParsedQuantity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParsedQuantity

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

Formats the value using the given formatter.

impl Default for ParsedQuantity

fn default() -> ParsedQuantity

Returns the “default value” for a type.

impl Display for ParsedQuantity

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

Formats the value using the given formatter.

impl<T> Div<T> for ParsedQuantity

where T: Into<Decimal>,

type Output = ParsedQuantity

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign<T> for ParsedQuantity

where T: Into<Decimal>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<Decimal> for ParsedQuantity

fn from(value: Decimal) -> Self

Converts to this type from the input type.

impl From<ParsedQuantity> for Quantity

fn from(value: ParsedQuantity) -> Self

Converts to this type from the input type.

impl<T> Mul<T> for ParsedQuantity

where T: Into<Decimal>,

type Output = ParsedQuantity

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for ParsedQuantity

where T: Into<Decimal>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Neg for ParsedQuantity

type Output = ParsedQuantity

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for ParsedQuantity

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

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

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

type Output = ParsedQuantity

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for ParsedQuantity

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<&Quantity> for ParsedQuantity

type Error = ParseQuantityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for ParsedQuantity

type Error = ParseQuantityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Quantity> for ParsedQuantity

type Error = ParseQuantityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for ParsedQuantity

type Error = ParseQuantityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for ParsedQuantity