Trait Document 

pub trait Document: Any + 'static {
    // Required methods
    fn inner(&self) -> DocGuard<'_>;
    fn inner_mut(&mut self) -> DocGuardMut<'_>;

    // Provided methods
    fn handle_ui_event(&mut self, event: UiEvent) { ... }
    fn poll(&mut self, task_context: Option<Context<'_>>) -> bool { ... }
    fn id(&self) -> usize { ... }
}

Abstraction over wrappers around BaseDocument to allow for them all to be driven by blitz-shell

Required Methods

fn inner(&self) -> DocGuard<'_>

fn inner_mut(&mut self) -> DocGuardMut<'_>

Provided Methods

fn handle_ui_event(&mut self, event: UiEvent)

Update the Document in response to a UiEvent (click, keypress, etc)

fn poll(&mut self, task_context: Option<Context<'_>>) -> bool

Poll any pending async operations, and flush changes to the underlying BaseDocument

fn id(&self) -> usize

Get the Document’s id

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Document for Rc<RefCell<BaseDocument>>

fn inner(&self) -> DocGuard<'_>

fn inner_mut(&mut self) -> DocGuardMut<'_>

Implementors

impl Document for BaseDocument

impl Document for HtmlDocument

impl Document for PlainDocument