Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thomask33/kube-quantity-rs

Kubernetes quantity arithmetics implemented in Rust
https://github.com/thomask33/kube-quantity-rs

arithmetic client kubernetes quantity rust rust-library

Last synced: 19 days ago
JSON representation

Kubernetes quantity arithmetics implemented in Rust

Host: GitHub
URL: https://github.com/thomask33/kube-quantity-rs
Owner: ThomasK33
License: apache-2.0
Created: 2023-02-24T10:49:14.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-30T08:25:58.000Z (about 2 months ago)
Last Synced: 2024-10-14T09:41:32.846Z (about 1 month ago)
Topics: arithmetic, client, kubernetes, quantity, rust, rust-library
Language: Rust
Homepage: https://crates.io/crates/kube_quantity
Size: 89.8 KB
Stars: 3
Watchers: 2
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # kube_quantity - Kubernetes Quantity Parser

[![Crates.io](https://img.shields.io/crates/v/kube_quantity)](https://crates.io/crates/kube_quantity)

`kube_quantity` is a library adding arithmetic operations to the [`Quantity`](https://arnavion.github.io/k8s-openapi/v0.17.x/k8s_openapi/apimachinery/pkg/api/resource/struct.Quantity.html#)

type from the [`k8s-openapi`](https://crates.io/crates/k8s-openapi) crate.

## Installation

Run the following Cargo command in your project directory to add the latest

stable version:

```bash

cargo add kube_quantity

```

Or add the following line to your Cargo.toml:

```toml

[dependencies]

kube_quantity = "0.8.0"

```

## Upgrading

Please check the [CHANGELOG](https://github.com/ThomasK33/kube-quantity-rs/blob/main/CHANGELOG.md)

when upgrading.

## Usage

## Parsing of quantities

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Parse from &str

let quantity = "1Ki";

let quantity: Result = quantity.try_into();

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

// Parse from a String

let quantity = String::from("2Mi");

let quantity: Result = quantity.try_into();

assert_eq!(quantity.unwrap().to_string(), "2Mi");

// Parse from a `k8s_openapi` Quantity

let quantity = Quantity("2.5Gi".to_string());

let quantity: Result = quantity.try_into();

assert_eq!(quantity.unwrap().to_string(), "2.5Gi");

```

### Addition of quantities

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("1Ki".to_string()).try_into();

let q2: Result = Quantity("2Ki".to_string()).try_into();

// Add parsed quantities

let q3: ParsedQuantity = q1.unwrap() + q2.unwrap();

// Convert parsed quantity back into a k8s quantity

let q3: Quantity = q3.into();

assert_eq!(q3.0, "3Ki");

```

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("4.2Ki".to_string()).try_into();

let q2: Result = Quantity("2.1Ki".to_string()).try_into();

// Add parsed quantities

let q3: ParsedQuantity = q1.unwrap() + q2.unwrap();

// Convert parsed quantity back into a k8s quantity

let q3: Quantity = q3.into();

assert_eq!(q3.0, "6.3Ki");

```

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

let q1: Result = Quantity("5M".to_string()).try_into();

let q2: Result = Quantity("7M".to_string()).try_into();

let mut q1 = q1.unwrap();

q1 += q2.unwrap();

let q1: Quantity = q1.into();

assert_eq!(q1.0, "12M");

```

### Multiplication of quantities

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("3k".to_string()).try_into();

// Multiply parsed quantities

let q1: ParsedQuantity = q1.unwrap() * 2;

// Convert parsed quantity back into a k8s quantity

let q2: Quantity = q1.into();

assert_eq!(q2.0, "6k");

```

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("3k".to_string()).try_into();

let mut q1: ParsedQuantity = q1.unwrap();

// Multiply parsed quantities

q1 *= 2;

// Convert parsed quantity back into a k8s quantity

let q2: Quantity = q1.into();

assert_eq!(q2.0, "6k");

```

### Division of quantities

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("4k".to_string()).try_into();

// Multiply parsed quantities

let q1: ParsedQuantity = q1.unwrap() / 2;

// Convert parsed quantity back into a k8s quantity

let q2: Quantity = q1.into();

assert_eq!(q2.0, "2k");

```

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("3k".to_string()).try_into();

let mut q1: ParsedQuantity = q1.unwrap();

// Multiply parsed quantities

q1 /= 3;

// Convert parsed quantity back into a k8s quantity

let q2: Quantity = q1.into();

assert_eq!(q2.0, "1k");

```

### Subtraction of quantities

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("1M".to_string()).try_into();

let q2: Result = Quantity("500k".to_string()).try_into();

// Subtract parsed quantities

let q3: ParsedQuantity = q1.unwrap() - q2.unwrap();

// Convert parsed quantity back into a k8s quantity

let q3: Quantity = q3.into();

assert_eq!(q3.0, "500k");

```

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Try parsing k8s quantities

let q1: Result = Quantity("10G".to_string()).try_into();

let q2: Result = Quantity("500M".to_string()).try_into();

let mut q1 = q1.unwrap();

q1 -= q2.unwrap();

let q1: Quantity = q1.into();

assert_eq!(q1.0, "9500M");

```

### Comparison of quantities

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Parse directly from &str

let q1 = "5Ki";

let q1: Result = q1.try_into();

let q1 = q1.unwrap();

assert_eq!(q1.to_string(), "5Ki");

// Parse from a `k8s_openapi` Quantity

let q2 = Quantity("2.5Gi".to_string());

let q2: Result = q2.try_into();

let q2 = q2.unwrap();

assert_eq!(q2.to_string(), "2.5Gi");

// Compare byte amount equality

assert!(q1 < q2);

```

```rust

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

use kube_quantity::{ParseQuantityError, ParsedQuantity};

// Parse directly from &str

let q1 = "1Ki";

let q1: Result = q1.try_into();

let q1 = q1.unwrap();

assert_eq!(q1.to_string(), "1Ki");

// Parse from a `k8s_openapi` Quantity

let q2 = Quantity("1024".to_string());

let q2: Result = q2.try_into();

let q2 = q2.unwrap();

assert_eq!(q2.to_string(), "1024");

// Compare byte amount equality

assert_eq!(q1, q2);

```

## License

Apache 2.0 licensed. See [LICENSE](https://github.com/ThomasK33/kube-quantity-rs/blob/main/LICENSE)

for details.