Struct Percentage 

pub struct Percentage { /* private fields */ }

A percentage value stored as a fraction

Internally stores a value from 0.0 to 1.0 (representing 0% to 100%). Values outside this range are allowed for certain use cases (e.g., animations).

Examples

use fop_types::Percentage;

// Create from percentage
let half = Percentage::from_percent(50.0);
assert_eq!(half.to_percent(), 50.0);
assert_eq!(half.as_fraction(), 0.5);

// Parse from string
let pct: Percentage = "75%".parse().unwrap();
assert_eq!(pct.to_percent(), 75.0);

Implementations

impl Percentage

pub const ZERO: Percentage

Zero percentage (0%)

pub const FULL: Percentage

Full percentage (100%)

pub const HALF: Percentage

Half percentage (50%)

pub const fn new(fraction: f64) -> Percentage

Create a new percentage from a fraction (0.0 = 0%, 1.0 = 100%)

Examples

use fop_types::Percentage;

let half = Percentage::new(0.5);
assert_eq!(half.to_percent(), 50.0);

pub fn from_percent(percent: f64) -> Percentage

Create a percentage from a percent value (0.0 = 0%, 100.0 = 100%)

Examples

use fop_types::Percentage;

let pct = Percentage::from_percent(75.0);
assert_eq!(pct.as_fraction(), 0.75);

pub fn to_percent(self) -> f64

Get the value as a percentage (0.0 to 100.0)

Examples

use fop_types::Percentage;

let pct = Percentage::new(0.25);
assert_eq!(pct.to_percent(), 25.0);

pub const fn as_fraction(self) -> f64

Get the value as a fraction (0.0 to 1.0)

Examples

use fop_types::Percentage;

let pct = Percentage::from_percent(50.0);
assert_eq!(pct.as_fraction(), 0.5);

pub fn of(self, base: Length) -> Length

Convert this percentage to a Length given a base value

Examples

use fop_types::{Percentage, Length};

let pct = Percentage::from_percent(50.0);
let base = Length::from_pt(100.0);
let result = pct.of(base);
assert!((result.to_pt() - 50.0).abs() < 0.001);

pub fn clamp(self) -> Percentage

Clamp the percentage to a valid range [0.0, 1.0]

Examples

use fop_types::Percentage;

let pct = Percentage::new(1.5);
let clamped = pct.clamp();
assert_eq!(clamped.as_fraction(), 1.0);

pub fn is_valid(self) -> bool

Check if the percentage is in the valid range [0.0, 1.0]

Trait Implementations

impl Add for Percentage

type Output = Percentage

The resulting type after applying the + operator.

fn add(self, other: Percentage) -> Percentage

Performs the + operation.

impl AddAssign for Percentage

fn add_assign(&mut self, other: Percentage)

Performs the += operation.

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<(), Error>

Formats the value using the given formatter.

impl Display for Percentage

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

Formats the value using the given formatter.

impl Div<f64> for Percentage

type Output = Percentage

The resulting type after applying the / operator.

fn div(self, scalar: f64) -> Percentage

Performs the / operation.

impl DivAssign<f64> for Percentage

fn div_assign(&mut self, scalar: f64)

Performs the /= operation.

impl FromStr for Percentage

type Err = FopError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Percentage, FopError>

Parses a string s to return a value of this type.

impl Mul<f64> for Percentage

type Output = Percentage

The resulting type after applying the * operator.

fn mul(self, scalar: f64) -> Percentage

Performs the * operation.

impl MulAssign<f64> for Percentage

fn mul_assign(&mut self, scalar: f64)

Performs the *= operation.

impl Neg for Percentage

type Output = Percentage

The resulting type after applying the - operator.

fn neg(self) -> Percentage

Performs the unary - operation.

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 Sub for Percentage

type Output = Percentage

The resulting type after applying the - operator.

fn sub(self, other: Percentage) -> Percentage

Performs the - operation.

impl SubAssign for Percentage

fn sub_assign(&mut self, other: Percentage)

Performs the -= operation.

impl Copy for Percentage

impl StructuralPartialEq for Percentage