rocket-file-cache 1.0.0

An in-memory file cache for the Rocket web framework.
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
88
89
90
91
92
93
94
95

use rocket::http::Status;
use rocket::response::{Response, Responder, NamedFile};
use rocket::request::Request;
use cache::Cache;
use std::path::Path;

use named_in_memory_file::NamedInMemoryFile;


/// Wrapper around data that can represent a file - either in memory (cache), or on disk.
///
/// When getting a `CachedFile` from the cache:
/// * An `InMemory` variant indicates that the file was read into the cache and a reference to that file is attached to the variant.
/// * A `FileSystem` variant indicates that the file is not in the cache, but it can be accessed from the filesystem.
/// * A `NotFound` variant indicates that the file can not be found in the filesystem or the cache.
#[derive(Debug)]
pub enum CachedFile<'a> {
    /// A file that has been loaded into the cache.
    InMemory(NamedInMemoryFile<'a>),
    /// A file that exists in the filesystem.
    FileSystem(NamedFile),
    /// The file does not exist in either the cache or the filesystem.
    NotFound
}

impl<'a> CachedFile<'a> {

    /// A convenience function that wraps the getting of a cached file.
    ///
    /// This is done to keep the code required to use the cache as similar to the typical use of
    /// rocket::response::NamedFile.
    pub fn open<P: AsRef<Path>>(path: P, cache: &'a Cache) -> CachedFile<'a> {
        cache.get(path)
    }
}


impl<'a> From<NamedInMemoryFile<'a>> for CachedFile<'a> {
    fn from(cached_file: NamedInMemoryFile<'a>) -> CachedFile<'a> {
        CachedFile::InMemory(cached_file)
    }
}

impl From<NamedFile> for CachedFile<'static> {
    fn from(named_file: NamedFile) -> Self {
        CachedFile::FileSystem(named_file)
    }
}

impl<'a> Responder<'a> for CachedFile<'a> {
    fn respond_to(self, request: &Request) -> Result<Response<'a>, Status> {

        match self {
            CachedFile::InMemory(cached_file) => cached_file.respond_to(request),
            CachedFile::FileSystem(named_file) => named_file.respond_to(request),
            CachedFile::NotFound => {
                error!("Response was `FileNotFound`.",);
                Err(Status::NotFound)
            }
        }
    }
}


impl<'a> PartialEq for CachedFile<'a> {
    fn eq(&self, other: &CachedFile) -> bool {
        match *self {
            CachedFile::InMemory(ref lhs_cached_file) => {
                match *other {
                    CachedFile::InMemory(ref rhs_cached_file) => (*rhs_cached_file.file).get() == (*lhs_cached_file.file).get(),
                    CachedFile::FileSystem(_) => false,
                    CachedFile::NotFound => false
                }
            }
            CachedFile::FileSystem(ref lhs_named_file) => {
                match *other {
                    CachedFile::InMemory(_) => false,
                    CachedFile::FileSystem(ref rhs_named_file) => {
                        // This just compares the file paths
                        *lhs_named_file.path() == *rhs_named_file.path()
                    }
                    CachedFile::NotFound => false
                }
            }
            CachedFile::NotFound => {
                match *other {
                    CachedFile::InMemory(_) => false,
                    CachedFile::FileSystem(_) => false,
                    CachedFile::NotFound => true
                }
            }
        }

    }
}