Skip to main content

CustomChannel

Struct CustomChannel 

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

Custom channel: hold a value of type T plus user-supplied write, read, and reset closures. Implements Channel (with a custom kind label) and is therefore registry-compatible alongside the stock channels.

Use this when none of the built-in channels match your semantics but you don’t want a whole new struct + trait impl.

Implementations§

Source§

impl<T: Default> CustomChannel<T>

Source

pub fn new<F>(label: &'static str, on_write: F) -> Self
where F: Fn(&mut T, T) + Send + Sync + 'static,

Build with a label, initial value, and a write(slot, incoming) merge function.

Source§

impl<T> CustomChannel<T>

Source

pub fn with_initial<F>(label: &'static str, initial: T, on_write: F) -> Self
where F: Fn(&mut T, T) + Send + Sync + 'static,

Build with explicit initial value.

Source

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

Apply an incoming write through the user-defined merge fn.

Source

pub fn get(&self) -> &T

Borrow the current value.

Source

pub fn get_mut(&mut self) -> &mut T

Mutably borrow the current value.

Source

pub fn replace(&mut self, new: T) -> T

Replace the wrapped value, returning the previous one.

Trait Implementations§

Source§

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

Source§

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

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

impl<T: Debug> Debug for CustomChannel<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

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

§

impl<T> !RefUnwindSafe for CustomChannel<T>

§

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

§

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

§

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

§

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

§

impl<T> !UnwindSafe for CustomChannel<T>

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