Struct CategoryConfig 

pub struct CategoryConfig {
    pub pool: u8,
    pub max_pages: u32,
    pub max_entries: u16,
    pub movable: bool,
    pub installs: bool,
    pub keep_radius: u32,
}

Budget and behaviour of one category.

Fields

pool: u8

The pool (see Config::pools) this category allocates from. Several categories may share one.

max_pages: u32

Most pages this category may hold, across all its entries.

max_entries: u16

Most entries (resident or in flight) this category may hold. 0 disables the category.

movable: bool

Whether compaction may move this category’s unpinned entries. A category whose bytes are addressed by hardware or by long-lived raw pointers (VRAM, SPU RAM, archetype packs) is not movable.

installs: bool

Whether a landed payload needs an install step (verify, relocate, upload) before it is resident. When false a finished read is resident.

keep_radius: u32

Unwanted entries farther than this are free victims; nearer ones are in the hysteresis band and go last. Set it to the lead radius plus the hysteresis, see CategoryConfig::keep_radius_for.

Implementations

impl CategoryConfig

pub const UNUSED: CategoryConfig

A disabled category.

pub const fn keep_radius_for(lead_radius: u32, region_width: u32) -> u32

The eviction keep radius the design prescribes: the lead radius plus a hysteresis of max(region_width, lead_radius / 4), so a player standing in a doorway cannot make two regions thrash.

Trait Implementations

impl Clone for CategoryConfig

fn clone(&self) -> CategoryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CategoryConfig

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

Formats the value using the given formatter.

impl PartialEq for CategoryConfig

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

impl Eq for CategoryConfig

impl StructuralPartialEq for CategoryConfig