From da2ab420cee41f5570568ce73b7c49613c794c55 Mon Sep 17 00:00:00 2001 From: Ethan Pailes Date: Sun, 26 Apr 2020 14:59:35 -0400 Subject: [PATCH] document that img handle constructors guess fmt This patch documents the fact that a couple of the image handle constructors know how to guess the image format based on the data that they are provided. I had to dig through `iced` sources until I discovered that those routines ultimately boil down to stuff like [image::load_from_memory][1] from the `image` crate, so I thought I would save others the trouble of doing the same reverse-engineering [1]: https://docs.rs/image/0.23.4/image/fn.load_from_memory.html --- native/src/widget/image.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/native/src/widget/image.rs b/native/src/widget/image.rs index 6bd0fd68..132f249d 100644 --- a/native/src/widget/image.rs +++ b/native/src/widget/image.rs @@ -123,6 +123,8 @@ pub struct Handle { impl Handle { /// Creates an image [`Handle`] pointing to the image of the given path. /// + /// Makes an educated guess about the image format by examining the data in the file. + /// /// [`Handle`]: struct.Handle.html pub fn from_path>(path: T) -> Handle { Self::from_data(Data::Path(path.into())) @@ -145,6 +147,8 @@ impl Handle { /// Creates an image [`Handle`] containing the image data directly. /// + /// Makes an educated guess about the image format by examining the given data. + /// /// This is useful if you already have your image loaded in-memory, maybe /// because you downloaded or generated it procedurally. ///