singlefile-formats 0.5.0

Default file format implementations for singlefile.
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

#![cfg_attr(docsrs, doc(cfg(feature = "cbor-serde")))]
#![cfg(feature = "cbor-serde")]

//! Defines a [`FileFormat`] using the CBOR binary data format.

pub extern crate ciborium as original;

use serde::ser::Serialize;
use serde::de::DeserializeOwned;
use singlefile::FileFormat;
use thiserror::Error;

use std::io::{Read, Write};

/// An error that can occur while using [`Cbor`].
#[derive(Debug, Error)]
pub enum CborError {
  /// An error occurred while serializing.
  #[error(transparent)]
  SerializeError(#[from] ciborium::ser::Error<std::io::Error>),
  /// An error occurred while deserializing.
  #[error(transparent)]
  DeserializeError(#[from] ciborium::de::Error<std::io::Error>)
}

/// A [`FileFormat`] corresponding to the CBOR binary data format.
/// Implemented using the [`ciborium`] crate, only compatible with [`serde`] types.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct Cbor;

impl<T> FileFormat<T> for Cbor
where T: Serialize + DeserializeOwned {
  type FormatError = CborError;

  fn from_reader<R: Read>(&self, reader: R) -> Result<T, Self::FormatError> {
    ciborium::de::from_reader(reader).map_err(From::from)
  }

  fn to_writer<W: Write>(&self, writer: W, value: &T) -> Result<(), Self::FormatError> {
    ciborium::ser::into_writer(value, writer).map_err(From::from)
  }
}

/// A shortcut type to a [`Compressed`][crate::compression::Compressed] [`Cbor`].
/// Provides a single parameter for compression format.
#[cfg_attr(docsrs, doc(cfg(feature = "compression")))]
#[cfg(feature = "compression")]
pub type CompressedCbor<C> = crate::compression::Compressed<C, Cbor>;