Struct vapcore_light::net::request_credits::FlowParams

pub struct FlowParams { /* fields omitted */ }

Handles costs, recharge, limits of request credits.

Implementations

impl FlowParams

pub fn new(limit: U256, costs: CostTable, recharge: U256) -> Self

Create new flow parameters from a request cost table, credit limit, and (minimum) rate of recharge.

pub fn from_request_times<F: Fn(Kind) -> Duration>(
    request_time: F,
    load_share: f64,
    max_stored: Duration
) -> Self

Create new flow parameters from , proportion of total capacity which should be given to a peer, and stored capacity a peer can accumulate.

pub fn free() -> Self

Create effectively infinite flow params.

pub fn limit(&self) -> &U256

Get a reference to the credit limit.

pub fn cost_table(&self) -> &CostTable

Get a reference to the cost table.

pub fn base_cost(&self) -> U256

Get the base cost of a request.

pub fn recharge_rate(&self) -> &U256

Get a reference to the recharge rate.

pub fn compute_cost(&self, request: &Request) -> Option<U256>

Compute the actual cost of a request, given the kind of request and number of requests made.

pub fn compute_cost_multi(&self, requests: &[Request]) -> Option<U256>

Compute the cost of a set of requests. This is the base cost plus the cost of each individual request.

pub fn create_credits(&self) -> Credits

Create initial credits.

pub fn recharge(&self, credits: &mut Credits)

Recharge the given credits based on time passed since last update.

pub fn refund(&self, credits: &mut Credits, refund_amount: U256)

Refund some credits which were previously deducted. Does not update the recharge timestamp.

Trait Implementations

impl Clone for FlowParams

fn clone(&self) -> FlowParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlowParams

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

Formats the value using the given formatter.

impl Default for FlowParams

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<FlowParams> for FlowParams

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for FlowParams