Skip to main content

Image

Struct Image 

Source
pub struct Image {
    pub source: ImageSource,
    pub format: ImageFormat,
    pub size: Vec2,
    /* private fields */
}
Expand description

Image.

Fields§

§source: ImageSource

Source.

§format: ImageFormat

Format.

§size: Vec2

Size (in pixels).

Implementations§

Source§

impl Image

Source

pub fn new_owned<SizeT>( data: Vec<u8>, compressed: bool, format: ImageFormat, size: SizeT, ) -> Self
where SizeT: Into<Vec2>,

Constructor.

Source

pub fn new_file<PathT, SizeT>( path: PathT, compressed: bool, format: ImageFormat, size: SizeT, ) -> Self
where PathT: Into<PathBuf>, SizeT: Into<Vec2>,

Constructor.

Examples found in repository?
examples/simple.rs (lines 14-19)
9fn main() {
10    let mut cursive = default();
11
12    // By default the image view uses "shrink" sizing
13
14    cursive.add_layer(Panel::new(ImageView::default().with_image(Image::new_file(
15        FILE,
16        false,
17        ImageFormat::PNG,
18        (96, 96),
19    ))));
20
21    cursive.add_global_callback('q', |cursive| cursive.quit());
22
23    cursive.run();
24}
Source

pub fn new_stream<ImageStreamT, SizeT>( stream: ImageStreamT, format: ImageFormat, size: SizeT, ) -> Self
where ImageStreamT: 'static + ImageStream + Send + Sync, SizeT: Into<Vec2>,

Constructor.

Source

pub fn into_owned(&mut self) -> Result<()>

Into owned.

Source§

impl Image

Source

pub fn new_owned_from_jpeg_file<PathT>( path: PathT, format: ImageFormat, compress: bool, ) -> Result<Self>
where PathT: AsRef<Path>,

Available on crate feature jpeg only.

Constructor.

Source

pub fn new_stream_from_jpeg_file<PathT>( path: PathT, format: ImageFormat, ) -> Result<Self>
where PathT: AsRef<Path>,

Available on crate feature jpeg only.

Constructor.

Examples found in repository?
examples/scrollable.rs (line 21)
12fn main() {
13    let mut cursive = default();
14
15    cursive.add_layer(
16        Panel::new(
17            ImageView::default()
18                .with_image(
19                    // This will decode the JPEG file on-demand
20                    // Note that RGBA is supported, too, if you need transparency
21                    Image::new_stream_from_jpeg_file(FILE, ImageFormat::RGB).expect("new_stream_from_jpeg_file"),
22                    // If you prefer to keep the image data in memory:
23                    // Image::new_owned_from_jpeg_file(FILE, ImageFormat::RGB, true).expect("new_owned_from_jpeg_file"),
24                )
25                .with_sizing(Sizing::original())
26                .scrollable()
27                .scroll_x(true),
28        )
29        .fixed_size((50, 20)),
30    );
31
32    cursive.add_global_callback('q', |cursive| cursive.quit());
33
34    cursive.run();
35}
Source§

impl Image

Source

pub fn new_png_file<PathT>(path: PathT) -> Result<Self>
where PathT: AsRef<Path>,

Available on crate feature png only.

Constructor.

Gets the image size by decoding the PNG header.

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

Trait Implementations§

Source§

impl Drop for Image

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl !Freeze for Image

§

impl !RefUnwindSafe for Image

§

impl Send for Image

§

impl Sync for Image

§

impl Unpin for Image

§

impl UnsafeUnpin for Image

§

impl !UnwindSafe for Image

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