Skip to main content

TopicChannel

Struct TopicChannel 

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

Topic channel: accumulates all published values into a list

This channel implements pub/sub messaging patterns where all writes are accumulated into a list. Each value is appended independently, allowing multiple publishers to send messages to the same topic.

§Type Parameters

  • T - The message type stored in the topic

§Examples

use juncture_core::state::channel::TopicChannel;

let mut channel: TopicChannel<String> = TopicChannel::new();

// Publish messages
channel.update(vec!["hello".to_string()]);
channel.update(vec!["world".to_string()]);

// Get all accumulated messages
let messages = channel.get();
assert_eq!(messages.len(), 2);
assert_eq!(messages[0], "hello");
assert_eq!(messages[1], "world");

// Reset for next superstep
channel.reset();
assert!(messages.is_empty());

Implementations§

Source§

impl<T> TopicChannel<T>

Source

pub const fn new() -> Self

Create a new empty topic channel

Source

pub const fn len(&self) -> usize

Get the number of messages in the topic

Source

pub const fn is_empty(&self) -> bool

Check if the topic is empty

Source

pub fn reset(&mut self)

Reset the topic, clearing all messages

This is typically called at the start of each superstep to clear ephemeral message accumulations.

Source

pub fn iter(&self) -> Iter<'_, T>

Get an iterator over the messages

Trait Implementations§

Source§

impl<T> Channel<Vec<T>> for TopicChannel<T>
where T: Clone + Send + Sync + Serialize + DeserializeOwned + 'static,

Source§

fn update(&mut self, values: Vec<Vec<T>>) -> bool

Update the channel with new values. Returns true if the value changed.
Source§

fn get(&self) -> &Vec<T>

Get the current value
Source§

fn consume(&mut self) -> bool

Check if the channel has been consumed (for trigger-based activation)
Source§

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

Create a checkpoint of the current value for persistence
Source§

fn from_checkpoint(value: Value) -> Result<Self, String>
where Self: Sized,

Restore from a checkpoint value Read more
Source§

impl<T: Clone> Clone for TopicChannel<T>

Source§

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

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<T: Debug> Debug for TopicChannel<T>

Source§

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

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

impl<T> Default for TopicChannel<T>

Source§

fn default() -> Self

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

impl<'a, T> IntoIterator for &'a TopicChannel<T>

Source§

type Item = &'a T

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl<T> Freeze for TopicChannel<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for TopicChannel<T>

§

impl<T> UnwindSafe for TopicChannel<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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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