rustdoc_copy_macro 0.2.0

Macros for `rustdoc_copy`
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

//! Provider of [`DocChunkMod`].

use crate::doc_parts::*;

/// Module parts for [`DocChunk`].
pub(crate) struct DocChunkMod<'a, 'd> {
    /// Document module path.
    mod_path: &'a syn::Path,
    /// Document chunk.
    chunk: &'a DocChunk<'d>,
    /// `true` if this is root.
    is_root: bool,
}

impl<'a, 'd> DocChunkMod<'a, 'd> {
    /// Returns a new instance for root.
    pub fn new_root(mod_path: &'a syn::Path, chunk: &'a DocChunk<'d>) -> Self {
        Self {
            chunk,
            mod_path,
            is_root: true,
        }
    }

    /// Returns a new instance for root.
    pub fn new_sub(mod_path: &'a syn::Path, chunk: &'a DocChunk<'d>) -> Self {
        Self {
            chunk,
            mod_path,
            is_root: false,
        }
    }

    /// Returns `true` if this is root.
    pub fn is_root(&self) -> bool {
        self.is_root
    }

    /// Returns document module path.
    pub fn mod_path(&self) -> &'a syn::Path {
        self.mod_path
    }

    /// Returns document module ID.
    pub fn mod_id(&self) -> &'a syn::Ident {
        &self.mod_path.segments.last().unwrap().ident
    }

    /// Returns document chunk.
    pub fn chunk(&self) -> &'a DocChunk<'d> {
        self.chunk
    }
}