Image

Struct Image 

Source
pub struct Image<'a> { /* private fields */ }
Expand description

A tui-rs Widget which displays an image.

Implementations§

Source§

impl<'a> Image<'a>

Source

pub fn with_img(img: RgbaImage) -> Image<'a>

Construct an Image widget with a single image.

Source

pub fn with_img_fn( img_fn: impl Fn(usize, usize) -> Result<RgbaImage, Error> + 'static, ) -> Image<'a>

Construct an Image widget with a function which can be called to obtain an image of the correct size.

Source

pub fn block(self, block: Block<'a>) -> Image<'a>

Set the widget to use the provided block.

Source

pub fn color_mode(self, color_mode: ColorMode) -> Image<'a>

Set the color mode used to render the image.

Source

pub fn style(self, style: Style) -> Image<'a>

Set the widget style.

Source

pub fn alignment(self, alignment: Alignment) -> Image<'a>

Set the widget alignment.

Trait Implementations§

Source§

impl<'a> Widget for Image<'a>

Source§

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

Auto Trait Implementations§

§

impl<'a> Freeze for Image<'a>

§

impl<'a> !RefUnwindSafe for Image<'a>

§

impl<'a> !Send for Image<'a>

§

impl<'a> !Sync for Image<'a>

§

impl<'a> Unpin for Image<'a>

§

impl<'a> !UnwindSafe for Image<'a>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.