Struct view::ViewSender

pub struct ViewSender { /* private fields */ }

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

Implementations

impl Sender

pub fn new(sender: Sender<ViewAction>) -> 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 refreshing the view.

pub fn clone_render_slice(&self) -> Arc<Mutex<RenderSlice>>

Clone the render slice.

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

Queue a start action.

Errors

Results in an error if the sender has been closed.

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

Queue a stop action.

Errors

Results in an error if the sender has been closed.

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

Queue an end action.

Errors

Results in an error if the sender has been closed.

pub fn scroll_top(&self)

Queue a scroll up action.

pub fn scroll_bottom(&self)

Queue a scroll up action.

pub fn scroll_up(&self)

Queue a scroll up action.

pub fn scroll_down(&self)

Queue a scroll down action.

pub fn scroll_left(&self)

Queue a scroll left action.

pub fn scroll_right(&self)

Queue a scroll right action.

pub fn scroll_page_up(&self)

Queue a scroll up a page action.

pub fn scroll_page_down(&self)

Queue a scroll down a page action.

pub fn resize(&self, width: u16, height: u16)

Queue a resize action.

pub fn render(&self, view_data: &ViewData) -> Result<()>

Sync the ViewData and queue a render action.

Errors

Results in an error if the sender has been closed.

Trait Implementations

impl Clone for Sender

fn clone(&self) -> Sender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sender

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

Formats the value using the given formatter.