Skip to main content

ImageDisplay

Struct ImageDisplay 

Source
pub struct ImageDisplay { /* private fields */ }
Expand description

A high-level interface for displaying images in the terminal

Implementations§

Source§

impl ImageDisplay

Source

pub fn new() -> Self

Create a new ImageDisplay instance

Source

pub fn quiet(self, mode: u8) -> Self

Set quiet mode (0 = all responses, 1 = suppress OK, 2 = suppress all)

Source

pub fn display_png_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Display a PNG image from file

Source

pub fn display_png(&self, data: &[u8]) -> Result<()>

Display a PNG image from memory

Source

pub fn display_rgba(&self, data: &[u8], width: u32, height: u32) -> Result<()>

Display raw RGBA data

Source

pub fn display_rgb(&self, data: &[u8], width: u32, height: u32) -> Result<()>

Display raw RGB data

Source

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

Clear all visible images

Source

pub fn transmit_png(&self, data: &[u8], image_id: u32) -> Result<()>

Transmit an image without displaying it (returns image ID for later use)

Source

pub fn place_image(&self, image_id: u32, cols: u32, rows: u32) -> Result<()>

Place a previously transmitted image

Trait Implementations§

Source§

impl Default for ImageDisplay

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.