fasrt 0.1.0

A blazing fast, zero-copy subtitle parser and writer for SRT and WebVTT in Rust.
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

/// A single subtitle entry in an SRT file.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Entry<H, T> {
  header: H,
  /// The text lines of this subtitle (joined with newlines on display).
  body: T,
}

impl<H, T> Entry<H, T> {
  /// Create a new `Entry` with the given header and body.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// assert_eq!(entry.header(), "Header");
  /// assert_eq!(entry.body(), "Body");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn new(header: H, body: T) -> Self {
    Self { header, body }
  }

  /// Returns the header of this subtitle entry, containing the index and timestamps.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// assert_eq!(entry.header(), "Header");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn header(&self) -> H
  where
    H: Copy,
  {
    self.header
  }

  /// Returns the header of this subtitle entry, containing the index and timestamps.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// assert_eq!(entry.header_ref(), &"Header");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn header_ref(&self) -> &H {
    &self.header
  }

  /// Returns the header of this subtitle entry, containing the index and timestamps.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let mut entry = Entry::new("Header", "Body");
  /// *entry.header_mut() = "New Header";
  /// assert_eq!(entry.header_mut(), &"New Header");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn header_mut(&mut self) -> &mut H {
    &mut self.header
  }

  /// Sets the header of this subtitle entry, containing the index and timestamps.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// let new_entry = entry.with_header("New Header");
  /// assert_eq!(new_entry.header(), "New Header");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub fn with_header(mut self, header: H) -> Self {
    self.set_header(header);
    self
  }

  /// Sets the header of this subtitle entry, containing the index and timestamps.
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub fn set_header(&mut self, header: H) -> &mut Self {
    self.header = header;
    self
  }

  /// Returns the body of this subtitle entry, containing the text lines.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// assert_eq!(entry.body(), "Body");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn body(&self) -> T
  where
    T: Copy,
  {
    self.body
  }

  /// Returns the body of this subtitle entry, containing the text lines.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// assert_eq!(entry.body_ref(), &"Body");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn body_ref(&self) -> &T {
    &self.body
  }

  /// Returns the body of this subtitle entry, containing the text lines.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let mut entry = Entry::new("Header", "Body");
  /// *entry.body_mut() = "New Body";
  /// assert_eq!(entry.body_ref(), &"New Body");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub const fn body_mut(&mut self) -> &mut T {
    &mut self.body
  }

  /// Sets the body of this subtitle entry, containing the text lines.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let entry = Entry::new("Header", "Body");
  /// let new_entry = entry.with_body("New Body");
  /// assert_eq!(new_entry.body(), "New Body");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub fn with_body(mut self, body: T) -> Self {
    self.set_body(body);
    self
  }

  /// Sets the body of this subtitle entry, containing the text lines.
  ///
  /// ```rust
  /// use fasrt::types::Entry;
  ///
  /// let mut entry = Entry::new("Header", "Body");
  /// entry.set_body("New Body");
  /// assert_eq!(entry.body(), "New Body");
  /// ```
  #[cfg_attr(not(tarpaulin), inline(always))]
  pub fn set_body(&mut self, body: T) -> &mut Self {
    self.body = body;
    self
  }
}