Struct weasel::event::MultiClientSinkHandleMut

pub struct MultiClientSinkHandleMut<'a, R> where
    R: BattleRules + 'static,  { /* fields omitted */ }

A structure to access and manipulate client sinks.

Methods

impl<'a, R> MultiClientSinkHandleMut<'a, R> where
    R: BattleRules + 'static, 

pub fn add_sink(&mut self, sink: Box<dyn ClientSink<R>>) -> WeaselResult<(), R>

Adds a new sink.

Sinks must have unique ids.

pub fn add_sink_from(
    &mut self,
    sink: Box<dyn ClientSink<R>>,
    event_id: EventId
) -> WeaselResult<(), R>

Adds a new sink and shares the battle history with it, starting from the event having event_id up to the most recent event.

Sinks must have unique ids.

pub fn add_sink_range(
    &mut self,
    sink: Box<dyn ClientSink<R>>,
    range: Range<EventId>
) -> WeaselResult<(), R>

Adds a new sink and shares a portion of the battle history with it. More precisely, only the events inside range will be sent to the sink.

Sinks must have unique ids.

pub fn send_range(
    &mut self,
    id: EventSinkId,
    range: Range<EventId>
) -> WeaselResult<(), R>

Sends a range of events from the battle history to the sink with the given id.

pub fn remove_sink(&mut self, id: EventSinkId)

Removes the sink with the given id.

pub fn sinks(&self) -> impl Iterator<Item = &Box<dyn ClientSink<R>>>

Returns an iterator over all sinks.