tui-markup 0.6.0

markup language for terminal styled text
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

use crate::generator::{Tag, TagG};

/// AST item.
///
/// In parsing stage, each line of source code will be parsed as a `Vec<Item>`, so the final result
/// is `Vec<Vec<Item>>`.
///
/// Tag conversion stage, Each tag will be converted from [`&str`] into [Tag] type the generator
/// needed, by using [`TagConvertor`][crate::generator::TagConvertor] of the generator.
///
/// In generating stage, generator will convert `Vec<Vec<Item<'_, Tag>>>` to final output.
#[derive(Debug, Clone, PartialEq)]
pub enum Item<'a, Tag = &'a str> {
    /// Plain text(escaped) without any style.
    PlainText(&'a str),
    /// A styled element, contains a series tag name and subitems.
    Element(Vec<Tag>, Vec<Item<'a, Tag>>),
}

/// Item type for tag convertor C.
pub type ItemC<'a, C> = Item<'a, Tag<'a, C>>;

/// Item type for generator G.
pub type ItemG<'a, G> = Item<'a, TagG<'a, G>>;