Struct DeviceBudget 

pub struct DeviceBudget {
    pub backend: BudgetBackend,
    pub total_bytes: u64,
    pub usable_bytes: u64,
    pub reserve_fraction: f64,
    pub source: String,
    pub approximate: bool,
}

A probed byte ceiling plus the sentence explaining where it came from. The sentence is not decoration: a budget a user cannot trace back to a query is a budget they will disable.

Fields

backend: BudgetBackend

total_bytes: u64

What the query returned, before the reserve.

usable_bytes: u64

total_bytes minus the reserve: what a plan may actually spend.

reserve_fraction: f64

Held-back fraction, as applied.

source: String

Human sentence naming the query, e.g. “Metal recommendedMaxWorkingSetSize”.

approximate: bool

True whenever the checkpoint is mmap’d – i.e. always, for GGUF – because resident weight bytes are then the kernel’s business, not ferrox’s. Kept as a field rather than a constant so nothing downstream can print the budget without deciding what to say about it.

Implementations

impl DeviceBudget

pub fn new( backend: BudgetBackend, total_bytes: u64, reserve: f64, source: String, ) -> Self

Applies reserve to total and records the source.

pub fn detect(backend: BudgetBackend) -> Self

Probes the backend the process is configured to use, honouring FERROX_DEVICE_BUDGET_BYTES first.

backend is the caller’s already-resolved choice (the CLI’s --device, the server’s FERROX_METAL/FERROX_CUDA), not a second guess at it – this module decides how much memory a backend has, never which backend runs.

pub fn is_unknown(&self) -> bool

True when nothing could be probed. Callers must treat this as “do not enforce” rather than “reject everything”: refusing to load because a probe failed would be worse than not checking.

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

The caveat sentence every printer of this number owes the user.

Trait Implementations

impl Clone for DeviceBudget

fn clone(&self) -> DeviceBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceBudget

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

Formats the value using the given formatter.

impl Display for DeviceBudget

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

Formats the value using the given formatter.

impl PartialEq for DeviceBudget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DeviceBudget