Enum StateScope 

pub enum StateScope {
    User,
    Context,
    Temp,
}

How long a remembered value lives, taken from the key’s prefix.

The prefix is part of the key the model writes and reads back, so the scope is visible wherever the key is — in the prompt, in a forget call, and in the store. Taken from Google ADK, which spells the same three this way.

Variants

User

user: — filed under the authenticated principal, so every context that principal opens reads it back.

Requires an authenticator. With no principal there is nothing to file it under, and storing it against the context instead would promise a lifetime it does not have.

Context

No prefix — filed under this context, and read back only here.

Temp

temp: — not stored anywhere.

It exists so the prefix means something: without it, temp:draft would be an ordinary key that outlives the turn under a name saying it does not.

Implementations

impl StateScope

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

The prefix a key in this scope carries.

pub fn is_stored(self) -> bool

Whether a store ever sees a key in this scope.

Trait Implementations

impl Clone for StateScope

fn clone(&self) -> StateScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StateScope

impl Debug for StateScope

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

Formats the value using the given formatter.

impl Eq for StateScope

impl Hash for StateScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StateScope

fn cmp(&self, other: &StateScope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StateScope

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StateScope

fn partial_cmp(&self, other: &StateScope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for StateScope