tiled 0.15.0

A rust crate for loading maps created by the Tiled editor
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use std::{
    collections::HashMap,
    path::{Path, PathBuf},
    sync::Arc,
};

use crate::{Template, Tileset};

/// A reference type that is used to refer to a resource. For the owned variant, see [`ResourcePathBuf`].
pub type ResourcePath = Path;
/// An owned type that is used to refer to a resource. For the non-owned variant, see [`ResourcePath`].
pub type ResourcePathBuf = PathBuf;

/// A trait identifying a data type that holds resources (such as tilesets) and maps them to a
/// [`ResourcePath`] to prevent loading them more than once. Normally you don't need to use this
/// type yourself unless you want to create a custom caching solution to, for instance, integrate
/// with your own.
///
/// If you simply want to load a map or tileset, use the [`Loader`](crate::Loader) type.
pub trait ResourceCache {
    /// Obtains a tileset from the cache, if it exists.
    ///
    /// # Example
    /// ```
    /// use std::fs::File;
    /// use tiled::{Tileset, Loader, ResourceCache};
    /// # use tiled::Result;
    /// # use std::sync::Arc;
    ///
    /// # fn main() -> Result<()> {
    /// let mut loader = Loader::new();
    /// let path = "assets/tilesheet.tsx";
    ///
    /// assert!(loader.cache().get_tileset(path).is_none());
    /// let tileset = Arc::new(loader.load_tsx_tileset(path)?);
    /// loader.cache_mut().insert_tileset(path, tileset);
    /// assert!(loader.cache().get_tileset(path).is_some());
    /// # Ok(())
    /// # }
    /// ```
    fn get_tileset(&self, path: impl AsRef<ResourcePath>) -> Option<Arc<Tileset>>;
    /// Insert a new tileset into the cache.
    ///
    /// See [`Self::get_tileset()`] for an example.
    fn insert_tileset(&mut self, path: impl AsRef<ResourcePath>, tileset: Arc<Tileset>);
    /// Obtains a template from the cache, if it exists.
    fn get_template(&self, path: impl AsRef<ResourcePath>) -> Option<Arc<Template>>;
    /// Insert a new template into the cache.
    fn insert_template(&mut self, path: impl AsRef<ResourcePath>, tileset: Arc<Template>);
}

/// A cache that identifies resources by their path, storing them in a [`HashMap`].
#[derive(Debug, Default)]
pub struct DefaultResourceCache {
    /// The tilesets cached until now.
    pub tilesets: HashMap<ResourcePathBuf, Arc<Tileset>>,
    /// The templates cached until now.
    pub templates: HashMap<ResourcePathBuf, Arc<Template>>,
}

impl DefaultResourceCache {
    /// Creates an empty [`DefaultResourceCache`].
    pub fn new() -> Self {
        Self {
            tilesets: HashMap::new(),
            templates: HashMap::new(),
        }
    }
}

impl ResourceCache for DefaultResourceCache {
    fn get_tileset(&self, path: impl AsRef<ResourcePath>) -> Option<Arc<Tileset>> {
        self.tilesets.get(path.as_ref()).map(Clone::clone)
    }

    fn insert_tileset(&mut self, path: impl AsRef<ResourcePath>, tileset: Arc<Tileset>) {
        self.tilesets.insert(path.as_ref().to_path_buf(), tileset);
    }

    fn get_template(&self, path: impl AsRef<ResourcePath>) -> Option<Arc<Template>> {
        self.templates.get(path.as_ref()).map(Clone::clone)
    }

    fn insert_template(&mut self, path: impl AsRef<ResourcePath>, tileset: Arc<Template>) {
        self.templates.insert(path.as_ref().to_path_buf(), tileset);
    }
}