Struct Percentage 

pub struct Percentage(/* private fields */);

A percentage value validated to the range [0, 100].

Implementations

impl Percentage

pub fn new(value: Decimal) -> Result<Self, PercentageError>

Create a new percentage, validating that the value is in [0, 100].

pub fn from_trusted(value: u32) -> Self

Create a percentage from a trusted u32 value.

Panics

Panics if value > 100.

pub fn value(&self) -> Decimal

The raw percentage value (0-100).

pub fn as_fraction(&self) -> Decimal

Convert to a fraction in [0.0, 1.0] (raw Decimal).

pub fn to_fraction(&self) -> Fraction

Convert to a validated Fraction value.

pub fn is_likely_fraction(&self) -> bool

Returns true if this value looks like it was passed as a fraction (0-1) instead of a percentage (0-100).

Values < 1.0 are suspiciously small for most percentage use cases (stop loss, margin requirement, risk limit).

Example

use rust_decimal_macros::dec;
use quant_primitives::Percentage;

let pct = Percentage::new(dec!(0.05)).unwrap();
assert!(pct.is_likely_fraction()); // 0.05% is suspicious — caller probably meant 5%

let normal = Percentage::new(dec!(5)).unwrap();
assert!(!normal.is_likely_fraction()); // 5% is plausible

pub fn zero() -> Self

The zero percentage.

pub fn hundred() -> Self

The 100% percentage.

Trait Implementations

impl Clone for Percentage

fn clone(&self) -> Percentage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Percentage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Percentage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Percentage

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

Formats the value using the given formatter.

impl Ord for Percentage

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Percentage

impl Eq for Percentage

impl StructuralPartialEq for Percentage