Skip to main content

Topic

Struct Topic 

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

Append-only queue. Producers send(), consumers drain() (single consumer) — mirrors V1 Topic channel.

Use Broadcast when more than one consumer needs to see every event.

Implementations§

Source§

impl<T> Topic<T>

Source

pub fn new() -> Self

New empty topic.

Source

pub fn send(&mut self, value: T)

Append value to the queue.

Source

pub fn extend<I: IntoIterator<Item = T>>(&mut self, values: I)

Append every item from values.

Source

pub fn drain(&mut self) -> Vec<T>

Drain the queue, returning everything currently buffered.

Source

pub fn peek(&self) -> &[T]

Borrow the current queue contents without consuming them.

Source

pub fn len(&self) -> usize

Number of pending items.

Source

pub fn is_empty(&self) -> bool

True if no items are pending.

Trait Implementations§

Source§

impl<T: Send + Sync> Channel for Topic<T>

Source§

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

Channel kind label, e.g. "AnyValue", "Topic".
Source§

impl<T: Clone> Clone for Topic<T>

Source§

fn clone(&self) -> Topic<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 Topic<T>

Source§

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

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

impl<T: Default> Default for Topic<T>

Source§

fn default() -> Topic<T>

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

impl<'de, T> Deserialize<'de> for Topic<T>
where T: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: PartialEq> PartialEq for Topic<T>

Source§

fn eq(&self, other: &Topic<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> Serialize for Topic<T>
where T: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T: Eq> Eq for Topic<T>

Source§

impl<T> StructuralPartialEq for Topic<T>

Auto Trait Implementations§

§

impl<T> Freeze for Topic<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for Topic<T>

§

impl<T> UnwindSafe for Topic<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<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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,