Struct Policy 

pub struct Policy { /* private fields */ }

Implementations

impl Policy

pub fn new(initial_amount: u32, pour_cost: u32, evaporation_cost: u32) -> Policy

pub fn bottom_less() -> Policy

Example

use uchimizu::Policy;

let p = Policy::bottom_less();
assert!(p.is_remaining(0, 0));
assert!(p.is_remaining(0, 1));
assert!(p.is_remaining(1, 1));

pub fn pierced() -> Policy

Example

use uchimizu::Policy;

let p = Policy::pierced();
assert!(!p.is_remaining(0, 0));
assert!(!p.is_remaining(0, 1));
assert!(!p.is_remaining(1, 1));

pub fn expire_within_counts(count: u32) -> Policy

Example

use uchimizu::Policy;

let p = Policy::expire_within_counts(5);
assert!(p.is_remaining(4, 1000));
assert!(!p.is_remaining(5, 1000));
assert!(!p.is_remaining(6, 1000));

pub fn expire_within_secs(secs: u32) -> Policy

Example

use uchimizu::Policy;

let p = Policy::expire_within_secs(5);
assert!(p.is_remaining(1000, 4));
assert!(!p.is_remaining(1000, 5));
assert!(!p.is_remaining(1000, 6));

pub fn is_remaining(&self, hit_count: u32, duration_secs: u32) -> bool

pub fn into_bucket<T>(self) -> Bucket<T>

Trait Implementations

impl<T> AsRef<Policy> for Bucket<T>

fn as_ref(&self) -> &Policy

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl PartialEq for Policy

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

impl StructuralPartialEq for Policy