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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
//! Generic CBOR tokenization.
use core::ops::{Deref, DerefMut};
use crate::data::Token;
use crate::decode::Error;
/// An [`Iterator`] over CBOR tokens.
///
/// The `Iterator` implementation calls [`Tokenizer::token`] until end of input has been reached.
///
/// *Requires feature* `"half"`.
#[derive(Debug, Clone)]
pub struct Tokenizer<'a, 'b> {
decoder: Decoder<'a, 'b>
}
impl<'a, 'b> Iterator for Tokenizer<'a, 'b> {
type Item = Result<Token<'b>, Error>;
fn next(&mut self) -> Option<Self::Item> {
match self.token() {
Ok(t) => Some(Ok(t)),
Err(e) if e.is_end_of_input() => None,
Err(e) => Some(Err(e))
}
}
}
impl<'b> From<crate::Decoder<'b>> for Tokenizer<'_, 'b> {
fn from(d: crate::Decoder<'b>) -> Self {
Tokenizer { decoder: Decoder::Owned(d) }
}
}
impl<'a, 'b> From<&'a mut crate::Decoder<'b>> for Tokenizer<'a, 'b> {
fn from(d: &'a mut crate::Decoder<'b>) -> Self {
Tokenizer { decoder: Decoder::Borrowed(d) }
}
}
impl<'a, 'b> Tokenizer<'a, 'b> {
/// Create a new Tokenizer for the given input bytes.
pub fn new(bytes: &'b[u8]) -> Self {
Tokenizer { decoder: Decoder::Owned(crate::Decoder::new(bytes)) }
}
/// Decode the next token.
///
/// Note that a sequence of tokens may not necessarily represent
/// well-formed CBOR items.
pub fn token(&mut self) -> Result<Token<'b>, Error> {
match self.decoder.decode() {
Ok(tk) => Ok(tk),
Err(e) => {
let end = self.decoder.input().len();
self.decoder.set_position(end); // drain decoder
Err(e)
}
}
}
}
#[cfg(feature = "alloc")]
impl core::fmt::Display for Tokenizer<'_, '_> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
/// Control stack element.
enum E {
N, // get next token
T, // tag
A(Option<u64>), // array
M(Option<u64>), // map
B, // indefinite bytes
D, // indefinite text
S(&'static str), // display string
X(&'static str) // display string (unless next token is BREAK)
}
let mut iter = self.clone().peekable();
let mut stack = alloc::vec::Vec::new();
while iter.peek().is_some() {
stack.push(E::N);
while let Some(elt) = stack.pop() {
match elt {
E::N => match iter.next() {
Some(Ok(Token::Array(n))) => {
stack.push(E::A(Some(n)));
f.write_str("[")?
}
Some(Ok(Token::Map(n))) => {
stack.push(E::M(Some(n)));
f.write_str("{")?
}
Some(Ok(Token::BeginArray)) => {
stack.push(E::A(None));
f.write_str("[_ ")?
}
Some(Ok(Token::BeginMap)) => {
stack.push(E::M(None));
f.write_str("{_ ")?
}
Some(Ok(Token::BeginBytes)) => if let Some(Ok(Token::Break)) = iter.peek() {
iter.next();
f.write_str("''_")?
} else {
stack.push(E::B);
f.write_str("(_ ")?
}
Some(Ok(Token::BeginString)) => if let Some(Ok(Token::Break)) = iter.peek() {
iter.next();
f.write_str("\"\"_")?
} else {
stack.push(E::D);
f.write_str("(_ ")?
}
Some(Ok(Token::Tag(t))) => {
stack.push(E::T);
write!(f, "{}(", u64::from(t))?
}
Some(Ok(t)) => t.fmt(f)?,
Some(Err(e)) => {
write!(f, " !!! decoding error: {}", e)?;
return Ok(())
}
None => continue
}
E::S(s) => f.write_str(s)?,
E::X(s) => match iter.peek() {
Some(Ok(Token::Break)) | None => continue,
Some(Ok(_)) => f.write_str(s)?,
Some(Err(e)) => {
write!(f, " !!! decoding error: {}", e)?;
return Ok(())
}
}
E::T => {
stack.push(E::S(")"));
stack.push(E::N)
}
E::A(Some(0)) => f.write_str("]")?,
E::A(Some(1)) => {
stack.push(E::A(Some(0)));
stack.push(E::N)
}
E::A(Some(n)) => {
stack.push(E::A(Some(n - 1)));
stack.push(E::S(", "));
stack.push(E::N)
}
E::A(None) => match iter.peek() {
None => {
write!(f, " !!! indefinite array not closed")?;
return Ok(())
}
Some(Ok(Token::Break)) => {
iter.next();
f.write_str("]")?
}
_ => {
stack.push(E::A(None));
stack.push(E::X(", "));
stack.push(E::N)
}
}
E::M(Some(0)) => f.write_str("}")?,
E::M(Some(1)) => {
stack.push(E::M(Some(0)));
stack.push(E::N);
stack.push(E::S(": "));
stack.push(E::N)
}
E::M(Some(n)) => {
stack.push(E::M(Some(n - 1)));
stack.push(E::S(", "));
stack.push(E::N);
stack.push(E::S(": "));
stack.push(E::N)
}
E::M(None) => match iter.peek() {
None => {
write!(f, " !!! indefinite map not closed")?;
return Ok(())
}
Some(Ok(Token::Break)) => {
iter.next();
f.write_str("}")?
}
_ => {
stack.push(E::M(None));
stack.push(E::X(", "));
stack.push(E::N);
stack.push(E::S(": "));
stack.push(E::N)
}
}
E::B => match iter.peek() {
None => {
write!(f, " !!! indefinite byte string not closed")?;
return Ok(())
}
Some(Ok(Token::Break)) => {
iter.next();
f.write_str(")")?
}
_ => {
stack.push(E::B);
stack.push(E::X(", "));
stack.push(E::N)
}
}
E::D => match iter.peek() {
None => {
write!(f, " !!! indefinite string not closed")?;
return Ok(())
}
Some(Ok(Token::Break)) => {
iter.next();
f.write_str(")")?
}
_ => {
stack.push(E::D);
stack.push(E::X(", "));
stack.push(E::N)
}
}
}
}
}
Ok(())
}
}
/// Either own or borrow a decoder (similar to `alloc::borrow::Cow`).
#[derive(Debug)]
enum Decoder<'a, 'b> {
Owned(crate::Decoder<'b>),
Borrowed(&'a mut crate::Decoder<'b>)
}
impl<'b> Deref for Decoder<'_, 'b> {
type Target = crate::Decoder<'b>;
fn deref(&self) -> &Self::Target {
match self {
Self::Owned(d) => d,
Self::Borrowed(d) => d
}
}
}
impl<'b> DerefMut for Decoder<'_, 'b> {
fn deref_mut(&mut self) -> &mut Self::Target {
match self {
Self::Owned(d) => d,
Self::Borrowed(d) => d
}
}
}
impl Clone for Decoder<'_, '_> {
fn clone(&self) -> Self {
match self {
Self::Owned(d) => Self::Owned(d.clone()),
Self::Borrowed(d) => Self::Owned((*d).clone())
}
}
}