Skip to main content

BudgetConfig

Struct BudgetConfig 

Source
pub struct BudgetConfig { /* private fields */ }
Expand description

Knobs that govern a MemoryBudget instance.

Construct via BudgetConfig::from_env or build by hand for tests. Field values are absolute bytes (not MiB) so downstream code never has to second-guess the unit.

Implementations§

Source§

impl BudgetConfig

Source

pub fn new(target_bytes: u64) -> Self

Build a config explicitly. Useful for tests.

Source

pub fn from_env(system_ram_bytes: Option<u64>) -> Self

Resolve a config from environment variables.

Reads:

  • MEMORY_BUDGET_TARGET_MIB (overrides the auto-derived target)
  • MEMORY_BUDGET_TICK_SECS (default 5)
  • MEMORY_BUDGET_HARD_CEILING_MIB (optional)

When MEMORY_BUDGET_TARGET_MIB is unset, the target is min(0.8 × system_ram, 4096 MiB). system_ram_bytes is the installed RAM as seen by sysinfo and is required when the target is derived automatically.

Source

pub fn target_bytes(&self) -> u64

Soft RSS target in bytes.

Source

pub fn hard_ceiling_bytes(&self) -> Option<u64>

Optional hard abort ceiling.

Source

pub fn tick(&self) -> Duration

Reapportionment cadence.

Source

pub fn with_tick(self, tick: Duration) -> Self

Override the reapportionment cadence. Convenience for tests that want to drive several ticks per second instead of one every five.

Trait Implementations§

Source§

impl Clone for BudgetConfig

Source§

fn clone(&self) -> Self

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 Debug for BudgetConfig

Source§

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

Formats the value using the given formatter. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more