Struct jsonrpsee_core::server::resource_limiting::Resources

pub struct Resources {
    pub capacities: ResourceTable,
    pub defaults: ResourceTable,
    pub labels: ResourceVec<&'static str>,
    /* private fields */
}

Available on crate feature server only.

User defined resources available to be used by calls on the JSON-RPC server. Each of the 8 possible resource kinds, for instance “cpu”, “io”, “nanobots”, store a maximum capacity and a default. A value of 0 means no limits for the given resource.

Fields

capacities: ResourceTable

Max capacity for all resource kinds

defaults: ResourceTable

Default value for all resource kinds; unless a method has a resource limit defined, this is the cost of a call (0 means no default limit)

labels: ResourceVec<&'static str>

Labels for every registered resource

Implementations

impl Resources

pub fn register(
    &mut self,
    label: &'static str,
    capacity: u16,
    default: u16
) -> Result<(), Error>

Register a new resource kind. Errors if label is already registered, or if the total number of registered resources would exceed 8.

pub fn claim(&self, units: ResourceTable) -> Result<ResourceGuard, Error>

Attempt to claim units units for each resource, incrementing current totals. If successful, returns a ResourceGuard which decrements the totals by the same amounts once dropped.

Trait Implementations

impl Clone for Resources

fn clone(&self) -> Resources

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Resources

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

Formats the value using the given formatter.

impl Default for Resources

fn default() -> Resources

Returns the “default value” for a type.