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 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
#![doc = include_str!("../README.md")]
use std::{
borrow::{Borrow, Cow},
collections::BTreeMap,
convert::TryFrom,
fmt::{Debug, Display, Write},
ops::Deref,
};
mod builder;
mod canonical;
mod check;
pub mod codec;
pub mod constants;
mod error;
mod reader;
mod validated;
pub mod value;
mod visit;
#[cfg(test)]
mod tests;
pub use builder::{
ArrayWriter, CborBuilder, CborOutput, DictWriter, Encoder, KeyBuilder, NoOutput, SingleBuilder,
SingleResult, WithOutput, Writer,
};
pub use error::{ErrorKind, ParseError, WhileParsing};
pub use reader::Literal;
pub use validated::{
indexing::{IndexStr, PathElement},
item::{ItemKind, ItemKindShort, TaggedItem},
iterators::{ArrayIter, BytesIter, DictIter, StringIter},
tags::{Tags, TagsShort},
};
pub use value::CborValue;
pub use visit::Visitor;
use canonical::canonicalise;
use smallvec::SmallVec;
use validated::indexing::IndexVisitor;
use visit::visit;
/// Wrapper around a byte slice that encodes a valid CBOR item.
///
/// For details on the format see [RFC 8949](https://www.rfc-editor.org/rfc/rfc8949).
///
/// When interpreting CBOR messages from the outside (e.g. from the network) it is
/// advisable to ingest those using the [`CborOwned::canonical`](struct.CborOwned.html#method.canonical) constructor.
/// In case the message was encoded for example using [`CborBuilder`](./struct.CborBuilder.html)
/// it is sufficient to use the [`unchecked`](#method.unchecked) constructor.
///
/// The Display implementation adheres to the [diagnostic notation](https://datatracker.ietf.org/doc/html/rfc8949#section-8).
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct Cbor([u8]);
impl From<&Cbor> for SmallVec<[u8; 16]> {
fn from(a: &Cbor) -> Self {
(&a.0).into()
}
}
impl Debug for Cbor {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut groups = 0;
f.write_str("Cbor(")?;
if f.alternate() {
for chunk in self.0.chunks(4) {
let c = if groups & 15 == 0 { '\n' } else { ' ' };
f.write_char(c)?;
groups += 1;
for byte in chunk {
write!(f, "{:02x}", byte)?;
}
}
f.write_char('\n')?;
} else {
for chunk in self.0.chunks(4) {
if groups > 0 {
f.write_char(' ')?;
} else {
groups = 1;
}
for byte in chunk {
write!(f, "{:02x}", byte)?;
}
}
}
f.write_char(')')
}
}
impl Display for Cbor {
fn fmt(&self, mut f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// check https://datatracker.ietf.org/doc/html/rfc8949#section-8 for the format
impl<'a> Visitor<'a, std::fmt::Error> for &mut std::fmt::Formatter<'_> {
fn visit_simple(&mut self, item: TaggedItem<'a>) -> Result<(), std::fmt::Error> {
write!(self, "{}", item)?;
Ok(())
}
fn visit_array_begin(
&mut self,
array: TaggedItem<'a>,
size: Option<u64>,
) -> Result<bool, std::fmt::Error> {
for tag in array.tags() {
write!(self, "{}(", tag)?;
}
write!(self, "[")?;
if size.is_none() {
write!(self, "_ ")?;
}
Ok(true)
}
fn visit_array_index(
&mut self,
_array: TaggedItem<'a>,
index: u64,
) -> Result<bool, std::fmt::Error> {
if index > 0 {
write!(self, ", ")?;
}
Ok(true)
}
fn visit_array_end(&mut self, array: TaggedItem<'a>) -> Result<(), std::fmt::Error> {
write!(self, "]")?;
for _ in array.tags() {
write!(self, ")")?;
}
Ok(())
}
fn visit_dict_begin(
&mut self,
dict: TaggedItem<'a>,
size: Option<u64>,
) -> Result<bool, std::fmt::Error> {
for tag in dict.tags() {
write!(self, "{}(", tag)?;
}
write!(self, "{{")?;
if size.is_none() {
write!(self, "_ ")?;
}
Ok(true)
}
fn visit_dict_key(
&mut self,
_dict: TaggedItem<'a>,
key: TaggedItem<'a>,
is_first: bool,
) -> Result<bool, std::fmt::Error> {
if !is_first {
write!(self, ", ")?;
}
write!(self, "{}: ", key)?;
Ok(true)
}
fn visit_dict_end(&mut self, dict: TaggedItem<'a>) -> Result<(), std::fmt::Error> {
write!(self, "}}")?;
for _ in dict.tags() {
write!(self, ")")?;
}
Ok(())
}
}
visit(&mut f, self.tagged_item())
}
}
impl AsRef<[u8]> for Cbor {
fn as_ref(&self) -> &[u8] {
&self.0
}
}
impl<'a> TryFrom<&'a [u8]> for &'a Cbor {
type Error = error::ParseError;
fn try_from(value: &'a [u8]) -> Result<Self, Self::Error> {
Cbor::checked(value)
}
}
impl ToOwned for Cbor {
type Owned = CborOwned;
fn to_owned(&self) -> Self::Owned {
CborOwned::unchecked(&self.0)
}
}
impl Cbor {
/// Unconditionally cast the given byte slice as CBOR item
///
/// No checks on the integrity are made, indexing methods may panic if encoded
/// lengths are out of bound or when encountering invalid encodings.
/// If you want to carefully treat data obtained from unreliable sources, prefer
/// [`CborOwned::canonical`](struct.CborOwned.html#method.canonical).
///
/// The results of [`CborBuilder`](struct.CborBuilder.html) can safely be fed to this method.
pub fn unchecked(bytes: &[u8]) -> &Self {
unsafe { std::mem::transmute(bytes) }
}
/// Unconditionally convert the given bytes as CBOR item
///
/// The borrowed variant is converted using [`unchecked`](#method.unchecked) without
/// allocating. The owned variant is converted by either reusing the allocated vector
/// or storing the bytes inline (if they fit) and releasing the vector.
///
/// No checks on the integrity are made, indexing methods may panic if encoded
/// lengths are out of bound or when encountering invalid encodings.
/// If you want to carefully treat data obtained from unreliable sources, prefer
/// [`CborOwned::canonical`](struct.CborOwned.html#method.canonical).
pub fn from_cow_unchecked(bytes: Cow<'_, [u8]>) -> Cow<'_, Cbor> {
match bytes {
Cow::Borrowed(b) => Cow::Borrowed(Cbor::unchecked(b)),
Cow::Owned(v) => Cow::Owned(CborOwned::unchecked(v)),
}
}
/// Cast the given byte slice as CBOR item if the encoding is valid
pub fn checked(bytes: &[u8]) -> Result<&Self, ParseError> {
check::validate(bytes, false).map(|(cbor, _rest)| cbor)
}
/// Cast the given byte slice as CBOR item if the encoding is valid, permitting more bytes to follow the item
pub fn checked_prefix(bytes: &[u8]) -> Result<(&Self, &[u8]), ParseError> {
check::validate(bytes, true)
}
/// Convert the given bytes to a CBOR item if the encoding is valid
///
/// The borrowed variant is converted using [`checked`](#method.checked) without
/// allocating. The owned variant is converted using [`CborOwned::canonical`](struct.CborOwned.html#method.canonical).
pub fn from_cow_checked(bytes: Cow<'_, [u8]>) -> Result<Cow<'_, Cbor>, ParseError> {
match bytes {
Cow::Borrowed(b) => Cbor::checked(b).map(Cow::Borrowed),
Cow::Owned(v) => CborOwned::canonical(v).map(Cow::Owned),
}
}
/// A view onto the underlying bytes
pub fn as_slice(&self) -> &[u8] {
&self.0
}
/// Interpret the CBOR item at a higher level
///
/// While [`kind`](#method.kind) gives you precise information on how the item is encoded,
/// this method interprets the tag-based encoding according to the standard, adding for example
/// big integers, decimals, and floats, or turning base64-encoded text strings into binary strings.
pub fn decode(&self) -> CborValue<'_> {
CborValue::new(self.tagged_item())
}
/// An iterator over the tags present on this item, from outermost to innermost
pub fn tags(&self) -> Tags<'_> {
reader::tags(self.as_slice()).unwrap().0
}
/// The low-level encoding of this item, without its tags
pub fn kind(&self) -> ItemKind<'_> {
ItemKind::new(self)
}
/// The low-level encoding of this item with its tags
pub fn tagged_item(&self) -> TaggedItem<'_> {
TaggedItem::new(self)
}
/// More efficient shortcut for `.decode().is_null()` with error reporting.
pub fn try_null(&self) -> Result<(), TypeError> {
let item = self.tagged_item();
if CborValue::new(item).is_null() {
Ok(())
} else {
Err(TypeError {
target: "null",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
}
/// More efficient shortcut for `.decode().as_bool()` with error reporting.
pub fn try_bool(&self) -> Result<bool, TypeError> {
let item = self.tagged_item();
CborValue::new(item).as_bool().ok_or(TypeError {
target: "boolean",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// More efficient shortcut for `.decode().to_number()` with error reporting.
pub fn try_number(&self) -> Result<value::Number, TypeError> {
let item = self.tagged_item();
CborValue::new(item).to_number().ok_or(TypeError {
target: "number",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// More efficient shortcut for `.decode().as_timestamp()` with error reporting.
pub fn try_timestamp(&self) -> Result<value::Timestamp, TypeError> {
let item = self.tagged_item();
CborValue::new(item).as_timestamp().ok_or(TypeError {
target: "timestamp",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// More efficient shortcut for `.decode().to_bytes()` with error reporting.
pub fn try_bytes(&self) -> Result<Cow<[u8]>, TypeError> {
let item = self.tagged_item();
CborValue::new(item).to_bytes().ok_or(TypeError {
target: "byte string",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// More efficient shortcut for `.decode().to_str()` with error reporting.
pub fn try_str(&self) -> Result<Cow<str>, TypeError> {
let item = self.tagged_item();
CborValue::new(item).to_str().ok_or(TypeError {
target: "string",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// More efficient shortcut for `.decode().to_array()` with error reporting.
pub fn try_array(&self) -> Result<Vec<Cow<Cbor>>, TypeError> {
let item = self.tagged_item();
CborValue::new(item).to_array().ok_or(TypeError {
target: "array",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// More efficient shortcut for `.decode().to_dict()` with error reporting.
pub fn try_dict(&self) -> Result<BTreeMap<Cow<Cbor>, Cow<Cbor>>, TypeError> {
let item = self.tagged_item();
CborValue::new(item).to_dict().ok_or(TypeError {
target: "dictionary",
kind: item.kind().into(),
tags: item.tags().into(),
})
}
/// Extract a value by indexing into arrays and dicts, with path elements yielded by an iterator.
///
/// Returns None if an index doesn’t exist or the indexed object is neither an array nor a dict.
/// When the object under consideration is an array, the next path element must represent an
/// integer number.
///
/// Providing an empty iterator will yield the current Cbor item.
///
/// Returns a borrowed Cbor unless the traversal entered a TAG_CBOR_ITEM byte string with indefinite
/// encoding (in which case the bytes need to be assembled into a Vec before continuing). This cannot
/// happen if the item being indexed stems from [`CborOwned::canonical`](struct.CborOwned.html#method.canonical).
pub fn index<'a, 'b>(
&'a self,
path: impl IntoIterator<Item = PathElement<'b>>,
) -> Option<Cow<'a, Cbor>> {
visit(&mut IndexVisitor::new(path.into_iter()), self.tagged_item()).unwrap_err()
}
/// Extract a value by indexing into arrays and dicts, with path elements yielded by an iterator.
///
/// Returns None if an index doesn’t exist or the indexed object is neither an array nor a dict.
/// When the object under consideration is an array, the next path element must represent an
/// integer number.
///
/// Providing an empty iterator will yield the current Cbor item.
///
/// # Panics
///
/// Panics if this CBOR item contains a TAG_CBOR_ITEM byte string that has been index into by this
/// path traversal. Use [`CborOwned::canonical`](struct.CborOwned.html#method.canonical) to ensure
/// that this cannot happen.
pub fn index_borrowed<'a, 'b>(
&'a self,
path: impl IntoIterator<Item = PathElement<'b>>,
) -> Option<&'a Cbor> {
self.index(path).map(|cow| match cow {
Cow::Borrowed(b) => b,
Cow::Owned(_) => panic!("indexing required allocation"),
})
}
/// Visit the interesting parts of this CBOR item as guided by the given
/// [`Visitor`](trait.Visitor.html).
///
/// Returns `false` if the visit was not even begun due to invalid or non-canonical CBOR.
pub fn visit<'a, 'b, Err, V: Visitor<'a, Err> + 'b>(
&'a self,
visitor: &'b mut V,
) -> Result<(), Err> {
visit(visitor, self.tagged_item())
}
}
#[derive(Debug, PartialEq, Clone, Copy)]
pub struct TypeError {
target: &'static str,
kind: ItemKindShort,
tags: TagsShort,
}
impl Display for TypeError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"type error when reading {}: found {} (tags: {:?})",
self.target, self.kind, self.tags
)
}
}
impl std::error::Error for TypeError {}
/// Wrapper around a vector of bytes, for parsing as CBOR.
///
/// For details on the format see [RFC 8949](https://www.rfc-editor.org/rfc/rfc8949).
///
/// When interpreting CBOR messages from the outside (e.g. from the network) it is
/// advisable to ingest those using the [`canonical`](#method.canonical) constructor.
/// In case the message was encoded for example using [`CborBuilder`](./struct.CborBuilder.html)
/// it is sufficient to use the [`trusting`](#method.trusting) constructor.
///
/// Canonicalisation rqeuires an intermediary data buffer, which can be supplied (and reused)
/// by the caller to save on allocations.
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone)]
// 16 bytes is the smallest that makes sense on 64bit platforms (size of a fat pointer)
pub struct CborOwned(SmallVec<[u8; 16]>);
impl Debug for CborOwned {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
Debug::fmt(Borrow::<Cbor>::borrow(self), f)
}
}
impl Display for CborOwned {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
Display::fmt(Borrow::<Cbor>::borrow(self), f)
}
}
impl Borrow<Cbor> for CborOwned {
fn borrow(&self) -> &Cbor {
Cbor::unchecked(&*self.0)
}
}
impl AsRef<Cbor> for CborOwned {
fn as_ref(&self) -> &Cbor {
Cbor::unchecked(&*self.0)
}
}
impl AsRef<[u8]> for CborOwned {
fn as_ref(&self) -> &[u8] {
&*self.0
}
}
impl Deref for CborOwned {
type Target = Cbor;
fn deref(&self) -> &Self::Target {
self.borrow()
}
}
impl TryFrom<&[u8]> for CborOwned {
type Error = error::ParseError;
fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
Self::canonical(value)
}
}
impl CborOwned {
/// Copy the bytes and wrap for indexing.
///
/// No checks on the integrity are made, indexing methods may panic if encoded lengths are out of bound.
/// If you want to carefully treat data obtained from unreliable sources, prefer
/// [`canonical()`](#method.canonical).
pub fn unchecked(bytes: impl Into<SmallVec<[u8; 16]>>) -> Self {
Self(bytes.into())
}
/// Copy the bytes while checking for integrity and replacing indefinite (byte) strings with definite ones.
///
/// This constructor will go through and decode the whole provided CBOR bytes and write them into a
/// vector, thereby
///
/// - writing large arrays and dicts using indefinite size format
/// - writing numbers in their smallest form
///
/// For more configuration options like reusing a scratch space or preferring definite size encoding
/// see [`CborBuilder`](struct.CborBuilder.html).
pub fn canonical(bytes: impl AsRef<[u8]>) -> Result<Self, ParseError> {
canonicalise(bytes.as_ref(), CborBuilder::new())
}
/// Hand out the underlying SmallVec as a Vec<u8>
///
/// Will only allocate if the item is at most 16 bytes long.
pub fn into_vec(self) -> Vec<u8> {
self.0.into_vec()
}
}
/// Generate an iterator of [`PathElement`](struct.PathElement.html) from a string
///
/// A path element is either
///
/// - a string starting with any other character than dot or opening bracket
/// and delimited by the next dot or opening bracket
/// - a number enclosed in brackets
///
/// `None` is returned in case an opening bracket is not matched with a closing one
/// or the characters between brackets are not a valid representation of `u64`.
///
/// # Examples:
///
/// ```rust
/// use cbor_data::{Cbor, index_str, ItemKind};
///
/// let cbor = Cbor::checked(b"eActyx").unwrap();
///
/// // dict key `x`, array index 12, dict key `y`
/// assert_eq!(cbor.index(index_str("x[12].y")), None);
/// // empty string means the outermost item
/// assert!(matches!(cbor.index(index_str("")).unwrap().kind(), ItemKind::Str(s) if s == "Actyx"));
/// ```
pub fn try_index_str(s: &str) -> Option<IndexStr<'_>> {
IndexStr::new(s)
}
/// Generate an iterator of [`PathElement`](struct.PathElement.html) from a string
///
/// # Panics
///
/// Panics if the string is not valid, see [`try_index_str`](fn.try_index_str.html) for the
/// details and a non-panicking version.
///
/// # Example
///
/// ```rust
/// use cbor_data::{CborBuilder, index_str, Encoder, value::Number};
///
/// let cbor = CborBuilder::new().encode_array(|builder| {
/// builder.encode_u64(42);
/// });
///
/// let item = cbor.index(index_str("[0]")).unwrap();
/// assert_eq!(item.decode().to_number().unwrap(), Number::Int(42));
/// ```
pub fn index_str(s: &str) -> IndexStr<'_> {
try_index_str(s).expect("invalid index string")
}
struct DebugUsingDisplay<'a, T>(&'a T);
impl<'a, T: Display> Debug for DebugUsingDisplay<'a, T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
Display::fmt(self.0, f)
}
}