Trait surf_n_term::image::ImageHandler

pub trait ImageHandler: Send + Sync {
    // Required methods
    fn kind(&self) -> ImageHandlerKind;
    fn draw(
        &mut self,
        out: &mut dyn Write,
        img: &Image,
        pos: Position
    ) -> Result<(), Error>;
    fn erase(
        &mut self,
        out: &mut dyn Write,
        img: &Image,
        pos: Option<Position>
    ) -> Result<(), Error>;
    fn handle(
        &mut self,
        out: &mut dyn Write,
        event: &TerminalEvent
    ) -> Result<bool, Error>;
}

Image rendering/handling interface

Required Methods

fn kind(&self) -> ImageHandlerKind

Name

fn draw( &mut self, out: &mut dyn Write, img: &Image, pos: Position ) -> Result<(), Error>

Draw image

Send an appropriate terminal escape sequence so the image would be rendered.

fn erase( &mut self, out: &mut dyn Write, img: &Image, pos: Option<Position> ) -> Result<(), Error>

Erase image at specified position

This is needed when erasing characters is not actually removing image from the terminal. For example kitty needs to send separate escape sequence to actually erase image. If position is not specified all matching images are deleted.

fn handle( &mut self, out: &mut dyn Write, event: &TerminalEvent ) -> Result<bool, Error>

Handle events from the terminal

True means event has been handled and should not be propagated to a user

Trait Implementations

impl ImageHandler for Box<dyn ImageHandler>

fn kind(&self) -> ImageHandlerKind

Name

fn draw( &mut self, out: &mut dyn Write, img: &Image, pos: Position ) -> Result<(), Error>

Draw image

fn erase( &mut self, out: &mut dyn Write, img: &Image, pos: Option<Position> ) -> Result<(), Error>

Erase image at specified position

fn handle( &mut self, out: &mut dyn Write, event: &TerminalEvent ) -> Result<bool, Error>

Handle events from the terminal

Implementations on Foreign Types

impl ImageHandler for Box<dyn ImageHandler>

fn kind(&self) -> ImageHandlerKind

fn draw( &mut self, out: &mut dyn Write, img: &Image, pos: Position ) -> Result<(), Error>

fn erase( &mut self, out: &mut dyn Write, img: &Image, pos: Option<Position> ) -> Result<(), Error>

fn handle( &mut self, out: &mut dyn Write, event: &TerminalEvent ) -> Result<bool, Error>

Implementors

impl ImageHandler for DummyImageHandler

impl ImageHandler for KittyImageHandler

impl ImageHandler for SixelImageHandler