wiki-tui 0.5.0

A simple and easy to use Wikipedia Text User Interface
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

use crate::wiki::article::{element::ArticleElement, toc::TableOfContents};

/// A fully parsed article with an optional table of contents
#[derive(PartialEq, Debug, Clone)]
pub struct Article {
    /// The elements of the article
    elements: Vec<ArticleElement>,
    /// The optional table of contents of the article
    toc: Option<TableOfContents>,
}

impl Article {
    /// Creates a new article from given elements and a given table of contents. This should not be
    /// used directly, instead use the one the ArticleBuilder gives you
    pub fn new(elements: Vec<ArticleElement>, toc: Option<TableOfContents>) -> Self {
        log::debug!("creating a new instance of Article");
        Self { elements, toc }
    }

    /// Iterate over all of the elements contained in this article
    pub fn elements(&self) -> impl Iterator<Item = &ArticleElement> {
        self.elements.iter()
    }

    /// The optional table of contents
    pub fn toc(&self) -> Option<&TableOfContents> {
        self.toc.as_ref()
    }
}