spreet 0.13.1

Create a spritesheet from a set of SVG images
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use std::fs::{read, read_dir, DirEntry};
use std::path::{Path, PathBuf};

use resvg::usvg::{Options, Tree};

use crate::error::SpreetResult;

/// Returns `true` if `entry`'s file name starts with `.`, `false` otherwise.
fn is_hidden(entry: &DirEntry) -> bool {
    entry
        .file_name()
        .to_str()
        .map_or(false, |s| s.starts_with('.'))
}

/// Returns `true` if `entry` is a file with the extension `.svg`, `false` otherwise.
fn is_svg_file(entry: &DirEntry) -> bool {
    entry.path().is_file() && entry.path().extension().map_or(false, |s| s == "svg")
}

/// Returns `true` if `entry` is an SVG image and isn't hidden.
fn is_useful_input(entry: &DirEntry) -> bool {
    !is_hidden(entry) && is_svg_file(entry)
}

/// Returns a vector of file paths matching all SVGs within the given directory.
///
/// It ignores hidden files (files whose names begin with `.`) but it does follow symlinks. If
/// `recursive` is `true` it will also return file paths in sub-directories.
///
/// # Errors
///
/// This function will return an error if Rust's underlying [`read_dir`] returns an error.
pub fn get_svg_input_paths<P: AsRef<Path>>(path: P, recursive: bool) -> SpreetResult<Vec<PathBuf>> {
    Ok(read_dir(path)?
        .filter_map(|entry| {
            if let Ok(entry) = entry {
                let path_buf = entry.path();
                if recursive && path_buf.is_dir() {
                    get_svg_input_paths(path_buf, true).ok()
                } else if is_useful_input(&entry) {
                    Some(vec![path_buf])
                } else {
                    None
                }
            } else {
                None
            }
        })
        .flatten()
        .collect())
}

/// Load an SVG image from a file path.
pub fn load_svg<P: AsRef<Path>>(path: P) -> SpreetResult<Tree> {
    // The resources directory needs to be the same location as the SVG file itself, so that any
    // embedded resources (like PNGs in <image> elements) that use relative URLs can be resolved
    // correctly.
    let resources_dir = std::fs::canonicalize(&path)
        .ok()
        .and_then(|p| p.parent().map(Path::to_path_buf));
    let options = Options {
        resources_dir,
        ..Options::default()
    };

    Ok(Tree::from_data(&read(path)?, &options)?)
}