Use Cow<'static, [u8]> in image/svg, add constructors taking &[u8]`

This should resolve https://github.com/iced-rs/iced/issues/580 by
providing a way to use an image included with `include_bytes!` without
needing to copy it to a `Vec` to create an image handle.

It would be nice if these methods could also be `const`, but that isn't
possible due to the hashing being done.

This is technically a breaking change since `Handle::data()` is public.
But if that is used, it's most likely in used somewhere that only relies
on the type derefing to `&[u8]`.
This commit is contained in:
Ian Douglas Scott 2022-10-03 15:53:39 -07:00
parent 5f758d847f
commit 6ce12fc0c6
2 changed files with 37 additions and 6 deletions

View file

@ -1,6 +1,7 @@
//! Load and draw raster graphics.
use crate::{Hasher, Rectangle};
use std::borrow::Cow;
use std::hash::{Hash, Hasher as _};
use std::path::PathBuf;
use std::sync::Arc;
@ -29,7 +30,22 @@ impl Handle {
Self::from_data(Data::Pixels {
width,
height,
pixels,
pixels: Cow::Owned(pixels),
})
}
/// Like [`Handle::from_pixels`], but from static pixel data.
///
/// Useful for images included in binary, for instance with [`include_bytes!`].
pub fn from_static_pixels(
width: u32,
height: u32,
pixels: &'static [u8],
) -> Handle {
Self::from_data(Data::Pixels {
width,
height,
pixels: Cow::Borrowed(pixels),
})
}
@ -40,7 +56,14 @@ impl Handle {
/// This is useful if you already have your image loaded in-memory, maybe
/// because you downloaded or generated it procedurally.
pub fn from_memory(bytes: Vec<u8>) -> Handle {
Self::from_data(Data::Bytes(bytes))
Self::from_data(Data::Bytes(Cow::Owned(bytes)))
}
/// Like [`Handle::from_memory`], but from static image data.
///
/// Useful for images included in binary, for instance with [`include_bytes!`].
pub fn from_static_memory(bytes: &'static [u8]) -> Handle {
Self::from_data(Data::Bytes(Cow::Borrowed(bytes)))
}
fn from_data(data: Data) -> Handle {
@ -86,7 +109,7 @@ pub enum Data {
Path(PathBuf),
/// In-memory data
Bytes(Vec<u8>),
Bytes(Cow<'static, [u8]>),
/// Decoded image pixels in BGRA format.
Pixels {
@ -95,7 +118,7 @@ pub enum Data {
/// The height of the image.
height: u32,
/// The pixels.
pixels: Vec<u8>,
pixels: Cow<'static, [u8]>,
},
}

View file

@ -1,6 +1,7 @@
//! Load and draw vector graphics.
use crate::{Hasher, Rectangle};
use std::borrow::Cow;
use std::hash::{Hash, Hasher as _};
use std::path::PathBuf;
use std::sync::Arc;
@ -25,7 +26,14 @@ impl Handle {
/// This is useful if you already have your SVG data in-memory, maybe
/// because you downloaded or generated it procedurally.
pub fn from_memory(bytes: impl Into<Vec<u8>>) -> Handle {
Self::from_data(Data::Bytes(bytes.into()))
Self::from_data(Data::Bytes(Cow::Owned(bytes.into())))
}
/// Like [`Handle::from_memory`], but from static image data.
///
/// Useful for images included in binary, for instance with [`include_bytes!`].
pub fn from_static_memory(bytes: &'static [u8]) -> Handle {
Self::from_data(Data::Bytes(Cow::Borrowed(bytes)))
}
fn from_data(data: Data) -> Handle {
@ -64,7 +72,7 @@ pub enum Data {
/// In-memory data
///
/// Can contain an SVG string or a gzip compressed data.
Bytes(Vec<u8>),
Bytes(Cow<'static, [u8]>),
}
impl std::fmt::Debug for Data {