ddoc 0.18.0

doc site generator
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

use std::path::{
    Path,
    PathBuf,
};

#[derive(Debug, Clone)]
pub struct Sourced<E> {
    src: PathBuf,
    entity: E,
}
impl<E> Sourced<E> {
    pub fn new(
        entity: E,
        src: PathBuf,
    ) -> Self {
        Self { src, entity }
    }

    /// Return the source
    pub fn src(&self) -> &Path {
        &self.src
    }

    /// Return a reference to the wrapped entity
    pub fn entity(&self) -> &E {
        &self.entity
    }

    /// Return a mutable reference to the wrapped entity
    pub fn entity_mut(&mut self) -> &mut E {
        &mut self.entity
    }

    /// Return the entity, dropping the item
    pub fn take_entity(self) -> E {
        self.entity
    }

    /// Destructure the ided into the wrapped path and entity
    pub fn dismantle(self) -> (PathBuf, E) {
        (self.src, self.entity)
    }
}

impl<E> AsRef<E> for Sourced<E> {
    fn as_ref(&self) -> &E {
        &self.entity
    }
}

impl<E> std::ops::Deref for Sourced<E> {
    type Target = E;
    fn deref(&self) -> &Self::Target {
        &self.entity
    }
}