Skip to main content

RetentionPolicy

Struct RetentionPolicy 

Source
pub struct RetentionPolicy {
    pub max_age: Duration,
    pub max_completed_tasks: usize,
}
Expand description

How long, and how many, completed tasks the registry keeps observable.

Retention is block-granular: a block of 1,024 tasks is released as one unit once every task in it has completed and released its lifecycle token, and either the block’s newest completion is older than max_age or more than max_completed_tasks worth of blocks are resident. The cap holds regardless of age, and it counts resident blocks, so a block pinned by a running task and the block being filled count toward it.

A single long-running task keeps its own block resident (about 73 KiB) however many later tasks complete, and no other. The sweep visits resident blocks in a queue, eight per created block, so a settled block waits at most one lap of that queue. With k the larger of the cap in blocks and the pinned blocks plus the one being filled, the resident count stays at most M + ceil(M / 8) for the least M with M >= k + ceil(M / 8), about 9/7 of k, however many blocks are created.

After release, TaskRegistry::is_completed stays true and a cancel request still reports “already completed”; only per-task metadata and statistics are gone.

Fields§

§max_age: Duration

Completed-task metadata older than this may be released.

§max_completed_tasks: usize

Most completed tasks kept regardless of age, rounded up to whole blocks.

Implementations§

Source§

impl RetentionPolicy

Source

pub fn from_cleanup(config: &CleanupConfig) -> Option<Self>

The policy an executor derives from its cleanup configuration, or None when automatic cleanup is disabled.

Trait Implementations§

Source§

impl Clone for RetentionPolicy

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 Copy for RetentionPolicy

Source§

impl Debug for RetentionPolicy

Source§

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

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

impl Eq for RetentionPolicy

Source§

impl PartialEq for RetentionPolicy

Source§

fn eq(&self, other: &Self) -> 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 RetentionPolicy

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 = !

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.