Struct input::Sender

pub struct Sender<CustomEvent: CustomEvent> { /* private fields */ }

Represents a message sender and receiver for passing actions between threads.

Implementations

impl<CustomEvent: CustomEvent> Sender<CustomEvent>

pub fn new(
    sender: Sender<EventAction<CustomEvent>>,
    receiver: Receiver<()>
) -> Self

Create a new instance.

pub fn clone_poisoned(&self) -> Arc<AtomicBool>

Clone the poisoned flag.

pub fn is_poisoned(&self) -> bool

Is the sender poisoned, and not longer accepting actions.

pub fn is_paused(&self) -> bool

Is the sender paused from reading events.

pub fn end(&self) -> Result<()>

Queue an end action.

Errors

Results in an error if the sender has been closed.

pub fn read_event(&mut self) -> Event<CustomEvent>

Read an event from the queue

pub fn enqueue_event(&self, event: Event<CustomEvent>) -> Result<()>

Add an event after existing events.

Errors

Results in an error if the sender has been closed.

pub fn push_event(&self, event: Event<CustomEvent>) -> Result<()>

Add an event before existing events.

Errors

Results in an error if the sender has been closed.

pub fn pause(&self)

Pause the event read thread.

pub fn resume(&self)

Resume the event read thread.

Trait Implementations

impl<CustomEvent: Clone + CustomEvent> Clone for Sender<CustomEvent>

fn clone(&self) -> Sender<CustomEvent>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CustomEvent: Debug + CustomEvent> Debug for Sender<CustomEvent>

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

Formats the value using the given formatter.