Struct netidx::subscriber::Val

pub struct Val(_);

A non durable subscription to a value. If all user held references to Val are dropped then it will be unsubscribed.

Implementations

impl Val

pub fn downgrade(&self) -> ValWeak

pub fn last(&self) -> Event

Get the last event value.

pub fn updates(
    &self,
    flags: UpdatesFlags,
    tx: Sender<Pooled<Vec<(SubId, Event)>>>
)

Register tx to receive updates to this Val.

You may register multiple different channels to receive updates from a Val, and you may register one channel to receive updates from multiple Vals.

If you register multiple channels pointing to the same receiver you will not get duplicate updates. However, if you register a duplicate channel and begin_with_last is true you will get an update with the current state, even though the channel registration will be ignored.

pub fn write(&self, v: Value)

Write a value back to the publisher. This will start going out as soon as this method returns, and you can call flush on the subscriber to get pushback in case of a slow publisher.

The publisher will receive multiple writes in the order you call write.

The publisher will not reply to your write, except that it may update values you are subscribed to, or trigger some other observable action.

pub fn write_with_recipt(&self, v: Value) -> Receiver<Value>

This does the same thing as write except that it requires the publisher send a reply indicating the outcome of the request. The reply can be read from the returned oneshot channel.

Note that compared to write this function has higher overhead, avoid it in situations where high message volumes are required.

pub fn id(&self) -> SubId

Get the unique id of this subscription.

Trait Implementations

impl Clone for Val

fn clone(&self) -> Val

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Val

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

Formats the value using the given formatter.