acdc-parser 0.9.0

`AsciiDoc` parser using PEG grammars
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use std::ops::Deref;

use serde::{Serialize, ser::Serializer};

use super::inlines::InlineNode;

/// A title in a document (section titles, block titles, document title, etc.).
///
/// `Title` is a newtype wrapper around `Vec<InlineNode>` that provides convenient
/// access to inline content. Titles can include formatting, links, and other inline
/// elements.
///
/// # Accessing Content
///
/// `Title` implements `Deref<Target=[InlineNode]>`, so you can use slice methods directly:
///
/// ```
/// # use acdc_parser::{Title, InlineNode};
/// let title = Title::new(vec![/* inline nodes */]);
///
/// // Iterate over inline nodes
/// for node in &title {
///     // ...
/// }
///
/// // Check if empty
/// if title.is_empty() {
///     // ...
/// }
///
/// // Access by index (via deref)
/// if let Some(first) = title.first() {
///     // ...
/// }
/// ```
///
/// # Serialization
///
/// Serializes as a plain JSON array of inline nodes for ASG compatibility.
#[derive(Clone, Debug, Default, PartialEq)]
#[non_exhaustive]
pub struct Title<'a>(Vec<InlineNode<'a>>);

impl Serialize for Title<'_> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        self.0.serialize(serializer)
    }
}

pub type Subtitle<'a> = Title<'a>;

impl<'a> Title<'a> {
    /// Creates a new `Title` with the given inline content.
    #[must_use]
    pub fn new(inlines: Vec<InlineNode<'a>>) -> Self {
        Self(inlines)
    }

    /// Consume the title, returning the underlying inline nodes.
    #[must_use]
    pub fn into_inlines(self) -> Vec<InlineNode<'a>> {
        self.0
    }

    /// Returns `true` if the title has no content.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns the number of inline nodes in the title.
    #[must_use]
    pub fn len(&self) -> usize {
        self.0.len()
    }
}

impl<'a> From<Vec<InlineNode<'a>>> for Title<'a> {
    fn from(inlines: Vec<InlineNode<'a>>) -> Self {
        Self(inlines)
    }
}

impl<'a> AsRef<[InlineNode<'a>]> for Title<'a> {
    fn as_ref(&self) -> &[InlineNode<'a>] {
        &self.0
    }
}

impl<'a> Deref for Title<'a> {
    type Target = [InlineNode<'a>];

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<'a, 'b> IntoIterator for &'b Title<'a> {
    type Item = &'b InlineNode<'a>;
    type IntoIter = std::slice::Iter<'b, InlineNode<'a>>;

    fn into_iter(self) -> Self::IntoIter {
        self.0.iter()
    }
}