Skip to main content

CpuQuota

Struct CpuQuota 

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

A cgroup CPU quota: how much CPU time the group may use per period.

Constructed only from a period that can produce a meaningful ratio, so there is no representable quota that divides by zero or yields a non-finite core count. An unlimited group is not a CpuQuota at all — it is MetricState::Unsupported on CpuSnapshot::cgroup_quota, mirroring how memory.max reading max becomes unsupported rather than u64::MAX.

Both raw figures are kept, not just the derived core count: someone debugging why their container is being throttled wants to see the 100000 200000 they configured, and deriving it back from 2.0 would lose the period.

Implementations§

Source§

impl CpuQuota

Source

pub fn new(quota_us: u64, period_us: u64) -> Option<Self>

Builds a quota, or None when it could not describe a real ceiling.

Rejects a zero period — division by zero — and a ratio that is not finite. A zero quota is accepted: a group allowed no CPU time at all is a real, if hostile, configuration, and reporting it as absent would hide it.

Source

pub fn cores(&self) -> f32

The ceiling as a number of CPUs, e.g. 1.5.

Source

pub const fn quota_us(&self) -> u64

Microseconds of CPU time allowed per period, as configured.

Source

pub const fn period_us(&self) -> u64

The accounting period in microseconds, as configured.

Trait Implementations§

Source§

impl Clone for CpuQuota

Source§

fn clone(&self) -> CpuQuota

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 CpuQuota

Source§

impl Debug for CpuQuota

Source§

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

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

impl PartialEq for CpuQuota

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CpuQuota

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, 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 = 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.