Struct Config 

pub struct Config<const CATEGORIES: usize> {
    pub pools: [PoolConfig; CATEGORIES],
    pub categories: [CategoryConfig; CATEGORIES],
    pub max_in_flight: u8,
    pub step_budget: u32,
    pub backoff: Backoff,
    pub displace_margin: u32,
    pub max_victim_tier: [u8; 5],
    pub protect_wanted: [bool; 5],
    pub cancel_for_demand: bool,
}

Everything configurable about a crate::Residency. CATEGORIES is both the number of category numbers in use and the number of pools.

Fields

pools: [PoolConfig; CATEGORIES]

Page pools, indexed by pool number.

categories: [CategoryConfig; CATEGORIES]

Category budgets, indexed by crate::Category::number. A key whose category number is out of range is ignored (and counted).

max_in_flight: u8

Requests the transport may hold at once (the design’s queue depth is 2). Cancelling requests do not count.

step_budget: u32

Bookkeeping budget per crate::Residency::step, in work units (see the crate docs). u32::MAX means unlimited.

backoff: Backoff

Retry schedule for failed reads and installs.

displace_margin: u32

A wanted entry of the same class as a requester is displaced only when it is farther than the requester by more than this (distance units), so two entries of nearly equal distance cannot trade places each frame.

max_victim_tier: [u8; 5]

Per requester class, the highest victim tier it may evict: 0 is an unwanted entry beyond the keep radius, 1 an unwanted entry inside the hysteresis band, 2 a wanted entry of lower priority than the requester. Indexed by Class::as_index.

protect_wanted: [bool; 5]

Per class, whether an entry wanted at that class this frame can never be evicted this frame. Indexed by Class::as_index.

cancel_for_demand: bool

Let a Class::Demand miss cancel the least urgent in-flight request when the transport is at depth.

Implementations

impl<const CATEGORIES: usize> Config<CATEGORIES>

pub const fn new() -> Self

All pools and categories disabled, the design’s default knobs: queue depth 2, unlimited step budget, the grid backoff, tiers [2, 2, 1, 0, 0], demand and combat fill protected, cancel for demand.

Trait Implementations

impl<const CATEGORIES: usize> Clone for Config<CATEGORIES>

fn clone(&self) -> Config<CATEGORIES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const CATEGORIES: usize> Debug for Config<CATEGORIES>

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

Formats the value using the given formatter.

impl<const CATEGORIES: usize> Default for Config<CATEGORIES>

fn default() -> Self

Returns the “default value” for a type.

impl<const CATEGORIES: usize> PartialEq for Config<CATEGORIES>

fn eq(&self, other: &Config<CATEGORIES>) -> 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<const CATEGORIES: usize> Copy for Config<CATEGORIES>

impl<const CATEGORIES: usize> Eq for Config<CATEGORIES>

impl<const CATEGORIES: usize> StructuralPartialEq for Config<CATEGORIES>