Struct Percent 

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

Percentage value from 0 to 100 inclusive.

Implementations

impl Percent

pub const MIN: u8 = 0

pub const MAX: u8 = 100

pub fn new(value: u8) -> PrimitiveResult<Self>

Creates a new percentage value.

Examples found in repository

examples/primitives_basic.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    type ServiceName = BoundedStr<3, 32>;

    let display_name = NonEmptyStr::new("Reliakit API")?;
    let service_name = ServiceName::new("api-service")?;
    let threshold = Percent::new(95)?;
    let port = Port::new(8080)?;
    let body_limit = ByteSize::from_mb(10);

    println!("display name: {display_name}");
    println!("service name: {service_name}");
    println!("threshold: {threshold}");
    println!("port: {port}");
    println!("body limit: {body_limit}");

    Ok(())
}

pub const fn get(self) -> u8

Returns the integer percentage value.

pub fn as_fraction(self) -> f64

Returns the percentage as a fraction between 0.0 and 1.0.

Trait Implementations

impl Clone for Percent

fn clone(&self) -> Percent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Percent

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

Formats the value using the given formatter.

impl Display for Percent

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

Formats the value using the given formatter.

impl From<Percent> for u8

fn from(value: Percent) -> Self

Converts to this type from the input type.

impl Hash for Percent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Percent

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

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

fn partial_cmp(&self, other: &Percent) -> 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 TryFrom<u8> for Percent

type Error = PrimitiveError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Percent

impl Eq for Percent

impl StructuralPartialEq for Percent