Skip to main content

RetentionPolicy

Struct RetentionPolicy 

Source
pub struct RetentionPolicy {
    pub max_per_thread: Option<usize>,
    pub max_age: Option<Duration>,
}
Expand description

How many checkpoints to keep for a thread, and for how long.

A long-running thread accumulates one checkpoint per super-step. Without a policy that grows without bound, which costs storage and slows a list.

The newest checkpoint is never removed, whatever the policy says: it is the one a resume loads, so discarding it would end the thread.

§Example

use adk_graph::checkpoint::RetentionPolicy;
use std::time::Duration;

// Keep the last 50 steps, and nothing older than a week.
let policy = RetentionPolicy::keep_last(50).with_max_age(Duration::from_secs(7 * 24 * 3600));

Fields§

§max_per_thread: Option<usize>

Keep at most this many checkpoints per thread, newest first.

§max_age: Option<Duration>

Remove checkpoints older than this.

Implementations§

Source§

impl RetentionPolicy

Source

pub fn keep_last(count: usize) -> Self

Keeps the newest count checkpoints for a thread.

A count of zero is raised to one, because the newest is always kept.

Source

pub fn max_age(age: Duration) -> Self

Removes checkpoints older than age.

Source

pub fn with_max_age(self, age: Duration) -> Self

Adds an age limit to a count limit.

Source

pub fn with_max_per_thread(self, count: usize) -> Self

Adds a count limit to an age limit.

Source

pub fn is_unlimited(&self) -> bool

Whether this policy would remove anything.

Source

pub fn expired(&self, checkpoints: &[Checkpoint]) -> Vec<String>

Selects the checkpoint ids this policy discards, newest always kept.

Shared by every backend so they cannot disagree about what to keep.

Trait Implementations§

Source§

impl Clone for RetentionPolicy

Source§

fn clone(&self) -> RetentionPolicy

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 RetentionPolicy

Source§

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

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

impl Default for RetentionPolicy

Source§

fn default() -> RetentionPolicy

Returns the “default value” for a type. Read more
Source§

impl Eq for RetentionPolicy

Source§

impl PartialEq for RetentionPolicy

Source§

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