Struct Rate 

pub struct Rate { /* private fields */ }

A resolved HMRC rate: currency units per £1, with exact Decimal arithmetic.

The crate never rounds. Callers apply whatever rounding their tax context requires.

Implementations

impl Rate

pub fn units_per_gbp(&self) -> Decimal

The canonical HMRC figure: how many currency units £1 buys.

pub fn to_gbp(&self, amount: Decimal) -> Decimal

Converts an amount in this rate’s currency to GBP (amount / units_per_gbp).

Exact division, round the result yourself.

Examples

use hmrc_rates::{YearMonth, Rates};
use rust_decimal::Decimal;

let rates = Rates::new();
let usd = rates.monthly_rate("USD", YearMonth::new(2025, 8).unwrap())?;
let gbp = usd.to_gbp(Decimal::from(2500));
println!("£{}", gbp.round_dp(2));

pub fn from_gbp(&self, gbp: Decimal) -> Decimal

Converts a GBP amount to this rate’s currency (gbp * units_per_gbp).

pub fn currency(&self) -> Currency

The currency this rate quotes against GBP.

pub fn period(&self) -> Period

The period the rate was published for. Reveals the substituted month after Rates::monthly_rate_or_earlier.

Trait Implementations

impl Clone for Rate

fn clone(&self) -> Rate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rate

impl Debug for Rate

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

Formats the value using the given formatter.

impl Eq for Rate

impl PartialEq for Rate

fn eq(&self, other: &Rate) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Rate