Skip to main content

EphemeralValue

Struct EphemeralValue 

Source
pub struct EphemeralValue<T> { /* private fields */ }
Expand description

A channel that is cleared after each superstep.

Ephemeral channels are useful for temporary data that should only be visible to nodes within a single superstep. After the step completes, the value is automatically cleared.

§Example

use rust_langgraph::channels::{BaseChannel, EphemeralValue};

let mut channel = EphemeralValue::<String>::new();
channel.update(vec![serde_json::json!("temporary")]).unwrap();
assert!(channel.get().unwrap().is_some());

// After superstep (simulated by calling clear)
channel.clear();
assert!(channel.get().unwrap().is_none());

Implementations§

Source§

impl<T> EphemeralValue<T>

Source

pub fn new() -> Self

Create a new empty EphemeralValue channel

Source

pub fn clear(&mut self)

Clear the ephemeral value

Trait Implementations§

Source§

impl<T> BaseChannel for EphemeralValue<T>
where T: Serialize + for<'de> Deserialize<'de> + Clone + Send + Sync + Debug + 'static,

Source§

fn get(&self) -> Result<Option<Value>>

Get the current value as JSON
Source§

fn update(&mut self, values: Vec<Value>) -> Result<()>

Update the channel with new values Read more
Source§

fn checkpoint(&self) -> Result<Value>

Serialize the channel state for checkpointing
Source§

fn from_checkpoint(_data: Value) -> Result<Box<dyn BaseChannel>>

Restore the channel state from a checkpoint
Source§

fn type_name(&self) -> &'static str

Get the channel’s type name for debugging
Source§

fn is_empty(&self) -> bool

Check if the channel is empty
Source§

impl<T: Clone> Clone for EphemeralValue<T>

Source§

fn clone(&self) -> EphemeralValue<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for EphemeralValue<T>

Source§

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

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

impl<T> Default for EphemeralValue<T>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<T> Freeze for EphemeralValue<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for EphemeralValue<T>
where T: RefUnwindSafe,

§

impl<T> Send for EphemeralValue<T>
where T: Send,

§

impl<T> Sync for EphemeralValue<T>
where T: Sync,

§

impl<T> Unpin for EphemeralValue<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for EphemeralValue<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for EphemeralValue<T>
where T: UnwindSafe,

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.