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

//! Provider of [`DocFileMod`].

use crate::doc_parts::*;

/// Module parts for [`doc_file`][crate::doc_file].
pub(crate) struct DocFileMod<'a> {
    /// ID of document module.
    mod_id: &'a syn::Ident,
    /// Document chunk.
    chunk: &'a DocChunk<'a>,
}

impl<'a> DocFileMod<'a> {
    /// Creates a new instance.
    pub fn new(mod_id: &'a syn::Ident, chunk: &'a DocChunk<'a>) -> Self {
        Self { mod_id, chunk }
    }

    /// Returns ID of document module.
    pub fn mod_id(&self) -> &'a syn::Ident {
        self.mod_id
    }

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