Struct Topic 

pub struct Topic { /* private fields */ }

PubSub topic channel.

Can accumulate values (accumulate=true) or clear each step. Used for the TASKS channel (holds Send objects).

Implementations

impl Topic

pub fn new(key: impl Into<String>, accumulate: bool) -> Self

Trait Implementations

impl Channel for Topic

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

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

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

Restore channel state from a checkpoint.

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

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

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

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

fn consume(&self) -> bool

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

fn is_available(&self) -> bool

Return true if the channel has a value available.

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

Clone this channel (for checkpoint restoration).

fn name(&self) -> &str

Return the name/key for this channel.

fn finish(&self) -> bool

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