null-kane

Crates.ionull-kane
lib.rsnull-kane
version2.0.4
sourcesrc
created_at2023-12-03 18:19:03.481484
updated_at2024-04-25 00:25:21.603312
descriptioncurrency crate with the option to add your own currency localization logic
homepage
repositoryhttps://gitlab.com/koopa1338/kane
max_upload_size
id1057039
size35,591
koopa (koopa1338)

documentation

README

null-kane

This is a Rust crate designed for currency manipulation. It provides an interface via a trait for implementing localization methods. The trait enables retrieval of the currency separator, thousand separator, and currency symbol.

Features

Localization Methods

  • get_separator: Retrieves the separator used for the currency.
  • get_thousand_separator: Retrieves the thousand separator used for the currency.
  • get_currency_symbol: Retrieves the currency symbol.

Arithmetic Operations

The crate implements arithmetic operations for the following types:

  • Addition, multiplication, and division among currencies.
  • Addition, multiplication, and division between currencies and usize.
  • Addition, multiplication, and division between currencies and f32.
  • Addition, multiplication, and division between currencies and f64.

Constructors

From implementations for creating instances from f32 and f64.

Example

use null_kane::{Currency, CurrencyLocalization};

#[derive(Clone, Default, PartialEq, Eq)]
enum MyLocalization {
    #[default]
    Euro
}

impl CurrencyLocalization for MyLocalization {
    fn get_separator(&self) -> char {
        // Implementation of the separator for Euro
        ','
    }

    fn get_thousand_separator(&self) -> char {
        // Implementation of the thousand separator for Euro
        '.'
    }

    fn get_currency_symbol(&self) -> &'static str {
        // Implementation of the currency symbol for Euro
        "€"
    }
}

fn main() {
    let euro_currency = MyLocalization::default;
    let amount_one = Currency::from(50.25_f32).with_locale(euro_currency.clone());
    let amount_two = Currency::from(30.75_f64).with_locale(euro_currency);

    let sum = amount_one + amount_two;
    let product = amount_one * 2.0;
    let division = amount_two / 3.0;

    println!("Sum: {}", sum);
    println!("Product: {}", product);
    println!("Division: {}", division);
}

TODO

  • implement a good solution for failing operations, for example if currency localizations don't match

  • consider using num trait

License

This project is licensed under the MIT License. See the LICENSE file for details.

Commit count: 49

cargo fmt