Struct tui_image::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

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. Read more

Auto Trait Implementations

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct tui_image::Image

Implementations

impl<'a> Image<'a>

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

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

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

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

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

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

Trait Implementations

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

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

Auto Trait Implementations

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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