Skip to main content

MemoryClass

Enum MemoryClass 

Source
pub enum MemoryClass {
    PageCache,
    DecodedCache,
    QueryExecution,
    ResultBuffering,
    AiCandidates,
    Compaction,
    Replication,
    Backup,
    NetworkBuffers,
}
Expand description

The memory pools of S1E-003: the budgets one node-level governor owns.

The variant set is exactly the spec’s, in spec order; index matches that order and is the layout of GovernorConfig::class_budgets.

Variants§

§

PageCache

Raw (on-disk form) page cache.

§

DecodedCache

Decoded (post-decompress/decrypt) page cache.

§

QueryExecution

Query execution operators (hash tables, sort runs in memory).

§

ResultBuffering

Result materialization and buffering.

§

AiCandidates

AI candidate sets (ANN/full-text retrieval buffers).

§

Compaction

Compaction and index maintenance.

§

Replication

Replication log shipping and follow-apply buffers. Reserved.

§

Backup

Backup/export buffers.

§

NetworkBuffers

Network receive/send buffers; carries the control-plane and replication protocols. Reserved.

Implementations§

Source§

impl MemoryClass

Source

pub const COUNT: usize = 9

Number of classes (array layout of the governor’s counters/budgets).

Source

pub const ALL: [MemoryClass; 9]

Every class, in spec order (the index layout).

Source

pub fn index(self) -> usize

Stable index in 0..COUNT (spec order).

Source

pub fn name(self) -> &'static str

Stable lowercase name.

Source

pub fn is_reserved(self) -> bool

Classes whose memory must never be fully starved (S1E-003 step 5, §13.1 reserved control/replication capacity): the replication pool, and the network buffers that carry the control-plane and replication protocols. Only these may draw down the reserved floor.

Source

pub fn is_low_priority(self) -> bool

Deferrable classes rejected first under pressure (S1E-003 step 1, §13.1 maintenance yields to foreground work).

Source

pub fn is_reclaimable_cache(self) -> bool

Classes whose memory is reclaimable on demand (S1E-003 step 2): the caches can evict entries and hand bytes back.

Source

pub fn is_spill_eligible(self) -> bool

Classes whose operator working memory the S1E-004 spill manager can move to disk under escalation step 3: query execution (hash tables, sort runs) and result materialization. The caches are reclaimed instead (step 2), AI candidate sets are recomputable, and the reserved pools are never spilled.

Trait Implementations§

Source§

impl Clone for MemoryClass

Source§

fn clone(&self) -> MemoryClass

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MemoryClass

Source§

impl Debug for MemoryClass

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MemoryClass

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for MemoryClass

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MemoryClass

Source§

impl Hash for MemoryClass

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for MemoryClass

Source§

fn cmp(&self, other: &MemoryClass) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for MemoryClass

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for MemoryClass

Source§

fn partial_cmp(&self, other: &MemoryClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for MemoryClass

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for MemoryClass

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.