Struct ratatu_image::picker::Picker

source ·
pub struct Picker { /* private fields */ }

Implementations§

source§

impl Picker

Helper for building widgets

source

pub fn new( font_size: FontSize, backend_type: BackendType, background_color: Option<Rgb<u8>> ) -> Result<Picker, Box<dyn Error>>

Create a picker from a given terminal FontSize.

Example
use std::io;
use ratatu_image::{
    picker::{BackendType, Picker},
    Resize,
};
use ratatui::{
    backend::{Backend, TestBackend},
    layout::Rect,
    Terminal,
};

let dyn_img = image::io::Reader::open("./assets/Ada.png").unwrap().decode().unwrap();
let mut picker = Picker::new(
    (7, 14),
    BackendType::Halfblocks,
    None,
).unwrap();

// For FixedImage:
let image_static = picker.new_static_fit(
    dyn_img,
    Rect::new(0, 0, 15, 5),
    Resize::Fit,
).unwrap();
// For ResizeImage:
let image_fit_state = picker.new_state();
source

pub fn set(&mut self, type: BackendType)

Set a specific backend

source

pub fn cycle_backends(&mut self) -> BackendType

Cycle through available backends

source

pub fn new_static_fit( &mut self, image: DynamicImage, size: Rect, resize: Resize ) -> Result<Box<dyn FixedBackend>, Box<dyn Error>>

Returns a new static backend for crate::FixedImage widgets that fits into the given size.

source

pub fn new_state(&mut self) -> Box<dyn ResizeBackend>

Returns a new state backend for crate::ResizeImage.

source

pub fn backend_type(&self) -> &BackendType

source

pub fn font_size(&self) -> FontSize

Trait Implementations§

source§

impl Clone for Picker

source§

fn clone(&self) -> Picker

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Copy for Picker

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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 Twhere U: TryFrom<T>,

§

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.