Skip to main content

BinaryOperatorAggregate

Struct BinaryOperatorAggregate 

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

Applies a binary operator to accumulate values.

Created when a state key uses a reducer (e.g., Annotated[list, add_messages]). Supports Overwrite to bypass the reducer.

Implementations§

Source§

impl BinaryOperatorAggregate

Source

pub fn new(key: impl Into<String>, reducer: ReducerFn) -> Self

Trait Implementations§

Source§

impl Channel for BinaryOperatorAggregate

Source§

fn checkpoint(&self) -> Option<JsonValue>

Return a serializable checkpoint of this channel’s state. Returns None if the channel is empty (MISSING).
Source§

fn from_checkpoint(&self, checkpoint: Option<&JsonValue>) -> Box<dyn Channel>

Restore channel state from a checkpoint.
Source§

fn update(&self, values: &[JsonValue]) -> Result<bool, ChannelError>

Apply a batch of updates. Returns true if the channel was modified.
Source§

fn get(&self) -> Result<JsonValue, ChannelError>

Get the current value. Returns Err(EmptyChannel) if empty.
Source§

fn is_available(&self) -> bool

Return true if the channel has a value available.
Source§

fn clone_channel(&self) -> Box<dyn Channel>

Clone this channel (for checkpoint restoration).
Source§

fn name(&self) -> &str

Return the name/key for this channel.
Source§

fn consume(&self) -> bool

Notify that a subscribed task consumed the value. Returns true if the channel was modified.
Source§

fn finish(&self) -> bool

Notify that the Pregel run is finishing. Returns true if the channel was modified.

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