Implement svg::Handle::from_memory

Useful if you already have your SVG data in memory.
This commit is contained in:
Héctor Ramón Jiménez 2020-03-31 00:39:18 +02:00
parent 6e9ab1cd6f
commit ae009158cc
4 changed files with 76 additions and 28 deletions

View File

@ -7,4 +7,3 @@ publish = false
[dependencies] [dependencies]
iced = { path = "../..", features = ["svg"] } iced = { path = "../..", features = ["svg"] }
env_logger = "0.7"

View File

@ -1,19 +1,16 @@
use iced::{Column, Container, Element, Length, Sandbox, Settings, Svg}; use iced::{Column, Container, Element, Length, Sandbox, Settings, Svg};
pub fn main() { pub fn main() {
env_logger::init();
Tiger::run(Settings::default()) Tiger::run(Settings::default())
} }
#[derive(Default)]
struct Tiger; struct Tiger;
impl Sandbox for Tiger { impl Sandbox for Tiger {
type Message = (); type Message = ();
fn new() -> Self { fn new() -> Self {
Self::default() Tiger
} }
fn title(&self) -> String { fn title(&self) -> String {
@ -24,7 +21,7 @@ impl Sandbox for Tiger {
fn view(&mut self) -> Element<()> { fn view(&mut self) -> Element<()> {
let content = Column::new().padding(20).push( let content = Column::new().padding(20).push(
Svg::new(format!( Svg::from_path(format!(
"{}/resources/tiger.svg", "{}/resources/tiger.svg",
env!("CARGO_MANIFEST_DIR") env!("CARGO_MANIFEST_DIR")
)) ))

View File

@ -2,8 +2,9 @@
use crate::{layout, Element, Hasher, Layout, Length, Point, Size, Widget}; use crate::{layout, Element, Hasher, Layout, Length, Point, Size, Widget};
use std::{ use std::{
hash::Hash, hash::{Hash, Hasher as _},
path::{Path, PathBuf}, path::PathBuf,
sync::Arc,
}; };
/// A vector graphics image. /// A vector graphics image.
@ -34,6 +35,14 @@ impl Svg {
} }
} }
/// Creates a new [`Svg`] that will display the contents of the file at the
/// provided path.
///
/// [`Svg`]: struct.Svg.html
pub fn from_path(path: impl Into<PathBuf>) -> Self {
Self::new(Handle::from_path(path))
}
/// Sets the width of the [`Svg`]. /// Sets the width of the [`Svg`].
/// ///
/// [`Svg`]: struct.Svg.html /// [`Svg`]: struct.Svg.html
@ -101,6 +110,7 @@ where
fn hash_layout(&self, state: &mut Hasher) { fn hash_layout(&self, state: &mut Hasher) {
std::any::TypeId::of::<Svg>().hash(state); std::any::TypeId::of::<Svg>().hash(state);
self.handle.hash(state);
self.width.hash(state); self.width.hash(state);
self.height.hash(state); self.height.hash(state);
} }
@ -112,7 +122,7 @@ where
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct Handle { pub struct Handle {
id: u64, id: u64,
path: PathBuf, data: Arc<Data>,
} }
impl Handle { impl Handle {
@ -120,17 +130,28 @@ impl Handle {
/// path. /// path.
/// ///
/// [`Handle`]: struct.Handle.html /// [`Handle`]: struct.Handle.html
pub fn from_path<T: Into<PathBuf>>(path: T) -> Handle { pub fn from_path(path: impl Into<PathBuf>) -> Handle {
use std::hash::Hasher as _; Self::from_data(Data::Path(path.into()))
}
let path = path.into(); /// Creates an SVG [`Handle`] from raw bytes containing either an SVG string
/// or gzip compressed data.
///
/// This is useful if you already have your SVG data in-memory, maybe
/// because you downloaded or generated it procedurally.
///
/// [`Handle`]: struct.Handle.html
pub fn from_memory(bytes: impl Into<Vec<u8>>) -> Handle {
Self::from_data(Data::Bytes(bytes.into()))
}
fn from_data(data: Data) -> Handle {
let mut hasher = Hasher::default(); let mut hasher = Hasher::default();
path.hash(&mut hasher); data.hash(&mut hasher);
Handle { Handle {
id: hasher.finish(), id: hasher.finish(),
path, data: Arc::new(data),
} }
} }
@ -141,20 +162,40 @@ impl Handle {
self.id self.id
} }
/// Returns a reference to the path of the [`Handle`]. /// Returns a reference to the SVG [`Data`].
/// ///
/// [`Handle`]: enum.Handle.html /// [`Data`]: enum.Data.html
pub fn path(&self) -> &Path { pub fn data(&self) -> &Data {
&self.path &self.data
} }
} }
impl<T> From<T> for Handle impl Hash for Handle {
where fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
T: Into<PathBuf>, self.id.hash(state);
{ }
fn from(path: T) -> Handle { }
Handle::from_path(path)
/// The data of an [`Svg`].
///
/// [`Svg`]: struct.Svg.html
#[derive(Clone, Hash)]
pub enum Data {
/// File data
Path(PathBuf),
/// In-memory data
///
/// Can contain an SVG string or a gzip compressed data.
Bytes(Vec<u8>),
}
impl std::fmt::Debug for Data {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Data::Path(path) => write!(f, "Path({:?})", path),
Data::Bytes(_) => write!(f, "Bytes(...)"),
}
} }
} }
@ -166,9 +207,10 @@ where
/// [`Svg`]: struct.Svg.html /// [`Svg`]: struct.Svg.html
/// [renderer]: ../../renderer/index.html /// [renderer]: ../../renderer/index.html
pub trait Renderer: crate::Renderer { pub trait Renderer: crate::Renderer {
/// Returns the default dimensions of an [`Svg`] located on the given path. /// Returns the default dimensions of an [`Svg`] for the given [`Handle`].
/// ///
/// [`Svg`]: struct.Svg.html /// [`Svg`]: struct.Svg.html
/// [`Handle`]: struct.Handle.html
fn dimensions(&self, handle: &Handle) -> (u32, u32); fn dimensions(&self, handle: &Handle) -> (u32, u32);
/// Draws an [`Svg`]. /// Draws an [`Svg`].

View File

@ -45,9 +45,19 @@ impl Cache {
let opt = resvg::Options::default(); let opt = resvg::Options::default();
let svg = match resvg::usvg::Tree::from_file(handle.path(), &opt.usvg) { let svg = match handle.data() {
Ok(tree) => Svg::Loaded(tree), svg::Data::Path(path) => {
Err(_) => Svg::NotFound, match resvg::usvg::Tree::from_file(path, &opt.usvg) {
Ok(tree) => Svg::Loaded(tree),
Err(_) => Svg::NotFound,
}
}
svg::Data::Bytes(bytes) => {
match resvg::usvg::Tree::from_data(&bytes, &opt.usvg) {
Ok(tree) => Svg::Loaded(tree),
Err(_) => Svg::NotFound,
}
}
}; };
let _ = self.svgs.insert(handle.id(), svg); let _ = self.svgs.insert(handle.id(), svg);