Skip to main content

ImageView

cursive_image

Struct ImageView 

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

Image view.

It will, of course, only work on terminals that support graphics. Relying on the viuer library, it supports the Kitty, iTerm, and Sixel (with the sixel feature) terminal graphics protocols.

The view supports fit or scale sizing modes (fit is the default), image alignment, and scrolling.

Implementations§

Source§

impl ImageView

Source

pub fn image(&self) -> Option<&DynamicImage>

Image.

Source

pub fn image_mut(&mut self) -> Option<&mut DynamicImage>

Image.

Source

pub fn set_image(&mut self, image: DynamicImage)

Set image.

Source

pub fn with_image(self, image: DynamicImage) -> Self

Set image.

Chainable.

Source

pub fn set_image_file<PathT>(&mut self, path: PathT)
where PathT: AsRef<Path>,

Set image.

Source

pub fn with_image_file<PathT>(self, path: PathT) -> Self
where PathT: AsRef<Path>,

Set image.

Chainable.

Examples found in repository?
examples/scrollable.rs (line 15)
10fn main() {
11    let mut cursive = default();
12
13    cursive.add_layer(
14        Panel::new(
15            ImageView::default().with_image_file(FILE).with_sizing(Sizing::original()).scrollable().scroll_x(true),
16        )
17        .fixed_size((50, 20)),
18    );
19
20    cursive.add_global_callback('q', |cursive| cursive.quit());
21
22    cursive.run();
23}
More examples
Hide additional examples
examples/simple.rs (line 14)
8fn main() {
9    let mut cursive = default();
10
11    // By default the image view uses "fit" sizing
12    // This means that it will require the minimal character box that fits the image
13
14    cursive.add_layer(Panel::new(ImageView::default().with_image_file(FILE)));
15
16    cursive.add_global_callback('q', |cursive| cursive.quit());
17
18    cursive.run();
19}
examples/positioning.rs (line 18)
15fn main() {
16    let mut cursive = default();
17
18    cursive.add_layer(Panel::new(ImageView::default().with_image_file(FILE).with_name(NAME).fixed_size((50, 20))));
19
20    cursive.add_global_callback('s', |cursive| {
21        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
22            image_view.set_sizing(match image_view.sizing() {
23                Sizing::Fit => Sizing::original(),
24                Sizing::Scale(_) => Sizing::Fit,
25            })
26        });
27    });
28
29    cursive.add_global_callback('h', |cursive| {
30        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
31            image_view.set_align(match image_view.align() {
32                Align { h: HAlign::Left, v } => Align { h: HAlign::Center, v },
33                Align { h: HAlign::Center, v } => Align { h: HAlign::Right, v },
34                Align { h: HAlign::Right, v } => Align { h: HAlign::Left, v },
35            })
36        });
37    });
38
39    cursive.add_global_callback('v', |cursive| {
40        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
41            image_view.set_align(match image_view.align() {
42                Align { h, v: VAlign::Top } => Align { h, v: VAlign::Center },
43                Align { h, v: VAlign::Center } => Align { h, v: VAlign::Bottom },
44                Align { h, v: VAlign::Bottom } => Align { h, v: VAlign::Top },
45            })
46        });
47    });
48
49    cursive.add_global_callback('q', |cursive| cursive.quit());
50
51    cursive.run();
52}
Source

pub fn sizing(&self) -> Sizing

Sizing.

Examples found in repository?
examples/positioning.rs (line 22)
15fn main() {
16    let mut cursive = default();
17
18    cursive.add_layer(Panel::new(ImageView::default().with_image_file(FILE).with_name(NAME).fixed_size((50, 20))));
19
20    cursive.add_global_callback('s', |cursive| {
21        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
22            image_view.set_sizing(match image_view.sizing() {
23                Sizing::Fit => Sizing::original(),
24                Sizing::Scale(_) => Sizing::Fit,
25            })
26        });
27    });
28
29    cursive.add_global_callback('h', |cursive| {
30        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
31            image_view.set_align(match image_view.align() {
32                Align { h: HAlign::Left, v } => Align { h: HAlign::Center, v },
33                Align { h: HAlign::Center, v } => Align { h: HAlign::Right, v },
34                Align { h: HAlign::Right, v } => Align { h: HAlign::Left, v },
35            })
36        });
37    });
38
39    cursive.add_global_callback('v', |cursive| {
40        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
41            image_view.set_align(match image_view.align() {
42                Align { h, v: VAlign::Top } => Align { h, v: VAlign::Center },
43                Align { h, v: VAlign::Center } => Align { h, v: VAlign::Bottom },
44                Align { h, v: VAlign::Bottom } => Align { h, v: VAlign::Top },
45            })
46        });
47    });
48
49    cursive.add_global_callback('q', |cursive| cursive.quit());
50
51    cursive.run();
52}
Source

pub fn set_sizing(&mut self, sizing: Sizing)

Set sizing.

Examples found in repository?
examples/positioning.rs (lines 22-25)
15fn main() {
16    let mut cursive = default();
17
18    cursive.add_layer(Panel::new(ImageView::default().with_image_file(FILE).with_name(NAME).fixed_size((50, 20))));
19
20    cursive.add_global_callback('s', |cursive| {
21        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
22            image_view.set_sizing(match image_view.sizing() {
23                Sizing::Fit => Sizing::original(),
24                Sizing::Scale(_) => Sizing::Fit,
25            })
26        });
27    });
28
29    cursive.add_global_callback('h', |cursive| {
30        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
31            image_view.set_align(match image_view.align() {
32                Align { h: HAlign::Left, v } => Align { h: HAlign::Center, v },
33                Align { h: HAlign::Center, v } => Align { h: HAlign::Right, v },
34                Align { h: HAlign::Right, v } => Align { h: HAlign::Left, v },
35            })
36        });
37    });
38
39    cursive.add_global_callback('v', |cursive| {
40        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
41            image_view.set_align(match image_view.align() {
42                Align { h, v: VAlign::Top } => Align { h, v: VAlign::Center },
43                Align { h, v: VAlign::Center } => Align { h, v: VAlign::Bottom },
44                Align { h, v: VAlign::Bottom } => Align { h, v: VAlign::Top },
45            })
46        });
47    });
48
49    cursive.add_global_callback('q', |cursive| cursive.quit());
50
51    cursive.run();
52}
Source

pub fn with_sizing(self, sizing: Sizing) -> Self

Set sizing.

Chainable.

Examples found in repository?
examples/scrollable.rs (line 15)
10fn main() {
11    let mut cursive = default();
12
13    cursive.add_layer(
14        Panel::new(
15            ImageView::default().with_image_file(FILE).with_sizing(Sizing::original()).scrollable().scroll_x(true),
16        )
17        .fixed_size((50, 20)),
18    );
19
20    cursive.add_global_callback('q', |cursive| cursive.quit());
21
22    cursive.run();
23}
Source

pub fn align(&self) -> Align

Align.

Examples found in repository?
examples/positioning.rs (line 31)
15fn main() {
16    let mut cursive = default();
17
18    cursive.add_layer(Panel::new(ImageView::default().with_image_file(FILE).with_name(NAME).fixed_size((50, 20))));
19
20    cursive.add_global_callback('s', |cursive| {
21        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
22            image_view.set_sizing(match image_view.sizing() {
23                Sizing::Fit => Sizing::original(),
24                Sizing::Scale(_) => Sizing::Fit,
25            })
26        });
27    });
28
29    cursive.add_global_callback('h', |cursive| {
30        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
31            image_view.set_align(match image_view.align() {
32                Align { h: HAlign::Left, v } => Align { h: HAlign::Center, v },
33                Align { h: HAlign::Center, v } => Align { h: HAlign::Right, v },
34                Align { h: HAlign::Right, v } => Align { h: HAlign::Left, v },
35            })
36        });
37    });
38
39    cursive.add_global_callback('v', |cursive| {
40        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
41            image_view.set_align(match image_view.align() {
42                Align { h, v: VAlign::Top } => Align { h, v: VAlign::Center },
43                Align { h, v: VAlign::Center } => Align { h, v: VAlign::Bottom },
44                Align { h, v: VAlign::Bottom } => Align { h, v: VAlign::Top },
45            })
46        });
47    });
48
49    cursive.add_global_callback('q', |cursive| cursive.quit());
50
51    cursive.run();
52}
Source

pub fn set_align(&mut self, align: Align)

Set align.

Examples found in repository?
examples/positioning.rs (lines 31-35)
15fn main() {
16    let mut cursive = default();
17
18    cursive.add_layer(Panel::new(ImageView::default().with_image_file(FILE).with_name(NAME).fixed_size((50, 20))));
19
20    cursive.add_global_callback('s', |cursive| {
21        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
22            image_view.set_sizing(match image_view.sizing() {
23                Sizing::Fit => Sizing::original(),
24                Sizing::Scale(_) => Sizing::Fit,
25            })
26        });
27    });
28
29    cursive.add_global_callback('h', |cursive| {
30        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
31            image_view.set_align(match image_view.align() {
32                Align { h: HAlign::Left, v } => Align { h: HAlign::Center, v },
33                Align { h: HAlign::Center, v } => Align { h: HAlign::Right, v },
34                Align { h: HAlign::Right, v } => Align { h: HAlign::Left, v },
35            })
36        });
37    });
38
39    cursive.add_global_callback('v', |cursive| {
40        _ = cursive.call_on_name(NAME, |image_view: &mut ImageView| {
41            image_view.set_align(match image_view.align() {
42                Align { h, v: VAlign::Top } => Align { h, v: VAlign::Center },
43                Align { h, v: VAlign::Center } => Align { h, v: VAlign::Bottom },
44                Align { h, v: VAlign::Bottom } => Align { h, v: VAlign::Top },
45            })
46        });
47    });
48
49    cursive.add_global_callback('q', |cursive| cursive.quit());
50
51    cursive.run();
52}
Source

pub fn with_align(self, align: Align) -> Self

Set align.

Chainable.

Trait Implementations§

Source§

impl Default for ImageView

Source§

fn default() -> Self

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

impl View for ImageView

Source§

fn type_name(&self) -> &'static str

Returns the type of this view. Read more
Source§

fn required_size(&mut self, constraint: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions. Read more
Source§

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout(). Read more
Source§

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided. Read more
Source§

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus. Read more
Source§

fn on_event(&mut self, _: Event) -> EventResult

Called when an event is received (key press, mouse event, …). Read more
Source§

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector. Read more
Source§

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector. Read more
Source§

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus. Read more
Source§

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible? 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> AnyView for T
where T: View,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast self to a Any.

Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Downcast self to a mutable Any.

Source§

fn as_boxed_any(self: Box<T>) -> Box<dyn Any>

Returns a boxed any from a boxed 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> Finder for T
where T: View,

Source§

fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F)
where V: View, F: FnMut(&mut V),

Runs a callback on all views identified by sel. Read more
Source§

fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Runs a callback on the view identified by sel. Read more
Source§

fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Convenient method to use call_on with a view::Selector::Name.
Source§

fn find_name<V>(&mut self, name: &str) -> Option<ViewRef<V>>
where V: View,

Convenient method to find a view wrapped in an NamedView.
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> IntoBoxedView for T
where T: View,

Source§

fn into_boxed_view(self) -> Box<dyn View>

Returns a Box<View>.
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> Nameable for T
where T: View,

Source§

fn with_name<S>(self, name: S) -> NamedView<Self>
where S: Into<String>,

Wraps this view into an NamedView with the given id. 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<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Resizable for T
where T: View,

Source§

fn resized( self, width: SizeConstraint, height: SizeConstraint, ) -> ResizedView<Self>

Wraps self in a ResizedView with the given size constraints.
Source§

fn fixed_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a fixed-size ResizedView.
Source§

fn fixed_width(self, width: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
Source§

fn fixed_height(self, height: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
Source§

fn full_screen(self) -> ResizedView<Self>

Wraps self into a full-screen ResizedView.
Source§

fn full_width(self) -> ResizedView<Self>

Wraps self into a full-width ResizedView.
Source§

fn full_height(self) -> ResizedView<Self>

Wraps self into a full-height ResizedView.
Source§

fn max_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a limited-size ResizedView.
Source§

fn max_width(self, max_width: usize) -> ResizedView<Self>

Wraps self into a limited-width ResizedView.
Source§

fn max_height(self, max_height: usize) -> ResizedView<Self>

Wraps self into a limited-height ResizedView.
Source§

fn min_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a ResizedView at least sized size.
Source§

fn min_width(self, min_width: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_width wide.
Source§

fn min_height(self, min_height: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_height tall.
Source§

impl<T> Scrollable for T
where T: View,

Source§

fn scrollable(self) -> ScrollView<Self>

Wraps self in a ScrollView.
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.
Source§

impl<T> With for T

Source§

fn wrap_with<U, F>(self, f: F) -> U
where F: FnOnce(Self) -> U,

Calls the given closure and return the result. Read more
Source§

fn with<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure on self.
Source§

fn try_with<E, F>(self, f: F) -> Result<Self, E>
where F: FnOnce(&mut Self) -> Result<(), E>,

Calls the given closure on self.
Source§

fn with_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure if condition == true.