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
//! Module that defines [`Encoding`] whith allows for customization of the
//! encoding format, and the [`DEFAULT`] encoding configuration.
use core::marker;
#[cfg(feature = "alloc")]
use alloc::vec::Vec;
#[cfg(feature = "std")]
use std::io;
use musli::de::Decode;
use musli::en::Encode;
use musli::mode::Binary;
use musli::Context;
use musli_utils::options;
use musli_utils::{FixedBytes, Options, Reader, Writer};
use crate::de::WireDecoder;
use crate::en::WireEncoder;
use crate::error::Error;
/// The default flavor used by the [`DEFAULT`] configuration.
pub const OPTIONS: options::Options = options::new().build();
/// The default configuration.
///
/// Uses variable-encoded numerical fields and variable-encoded prefix lengths.
///
/// The variable length encoding uses [`zigzag`] with [`continuation`] encoding
/// for numbers.
///
/// [`zigzag`]: musli_utils::int::zigzag
/// [`continuation`]: musli_utils::int::continuation
pub const DEFAULT: Encoding = Encoding::new();
/// Encode the given value to the given [`Writer`] using the [`DEFAULT`]
/// configuration.
#[inline]
pub fn encode<W, T>(writer: W, value: &T) -> Result<(), Error>
where
W: Writer,
T: ?Sized + Encode<Binary>,
{
DEFAULT.encode(writer, value)
}
/// Encode the given value to the given [`Write`] using the [`DEFAULT`]
/// configuration.
///
/// [`Write`]: io::Write
#[cfg(feature = "std")]
#[inline]
pub fn to_writer<W, T>(writer: W, value: &T) -> Result<(), Error>
where
W: io::Write,
T: ?Sized + Encode<Binary>,
{
DEFAULT.to_writer(writer, value)
}
/// Encode the given value to a [Vec] using the [`DEFAULT`] configuration.
#[cfg(feature = "alloc")]
#[inline]
pub fn to_vec<T>(value: &T) -> Result<Vec<u8>, Error>
where
T: ?Sized + Encode<Binary>,
{
DEFAULT.to_vec(value)
}
/// Encode the given value to a fixed-size bytes using the [`DEFAULT`]
/// configuration.
#[inline]
pub fn to_fixed_bytes<const N: usize, T>(value: &T) -> Result<FixedBytes<N>, Error>
where
T: ?Sized + Encode<Binary>,
{
DEFAULT.to_fixed_bytes::<N, _>(value)
}
/// Decode the given type `T` from the given [`Reader`] using the [`DEFAULT`]
/// configuration.
#[inline]
pub fn decode<'de, R, T>(reader: R) -> Result<T, Error>
where
R: Reader<'de>,
T: Decode<'de, Binary>,
{
DEFAULT.decode(reader)
}
/// Decode the given type `T` from the given slice using the [`DEFAULT`]
/// configuration.
#[inline]
pub fn from_slice<'de, T>(bytes: &'de [u8]) -> Result<T, Error>
where
T: Decode<'de, Binary>,
{
DEFAULT.from_slice(bytes)
}
/// Setting up encoding with parameters.
pub struct Encoding<const OPT: Options = OPTIONS, M = Binary> {
_marker: marker::PhantomData<M>,
}
impl Encoding<OPTIONS, Binary> {
/// Construct a new [`Encoding`] instance with the [`OPTIONS`]
/// configuration.
///
/// You can modify this using the available factory methods:
///
/// ```
/// use musli::{Encode, Decode};
/// use musli_utils::options::{self, Options, Integer};
/// use musli_wire::Encoding;
///
/// const OPTIONS: Options = options::new().with_integer(Integer::Fixed).build();
/// const CONFIG: Encoding<OPTIONS> = Encoding::new().with_options();
///
/// #[derive(Debug, PartialEq, Encode, Decode)]
/// struct Struct<'a> {
/// name: &'a str,
/// age: u32,
/// }
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut out = Vec::new();
///
/// let expected = Struct {
/// name: "Aristotle",
/// age: 61,
/// };
///
/// CONFIG.encode(&mut out, &expected)?;
/// let actual = CONFIG.decode(&out[..])?;
///
/// assert_eq!(expected, actual);
/// # Ok(()) }
/// ```
pub const fn new() -> Self {
Encoding {
_marker: marker::PhantomData,
}
}
}
impl<const OPT: Options, M> Encoding<OPT, M> {
/// Change the mode of the encoding.
///
/// # Examples
///
/// ```
/// use musli_wire::{OPTIONS, Encoding};
///
/// enum Custom {}
///
/// const CONFIG: Encoding<OPTIONS, Custom> = Encoding::new().with_mode();
/// ```
pub const fn with_mode<T>(self) -> Encoding<OPT, T> {
Encoding {
_marker: marker::PhantomData,
}
}
/// Change the options of the encoding.
///
/// # Examples
///
/// ```
/// use musli_utils::options::{self, Options, Integer};
/// use musli_wire::Encoding;
///
/// const OPTIONS: Options = options::new().with_integer(Integer::Fixed).build();
/// const CONFIG: Encoding<OPTIONS> = Encoding::new().with_options();
/// ```
pub const fn with_options<const U: Options>(self) -> Encoding<U, M> {
Encoding {
_marker: marker::PhantomData,
}
}
musli_utils::encoding_impls!(
M,
WireEncoder::<_, OPT, _>::new,
WireDecoder::<_, OPT, _>::new
);
musli_utils::encoding_from_slice_impls!(M);
}
impl<const OPT: Options, M> Clone for Encoding<OPT, M> {
#[inline]
fn clone(&self) -> Self {
*self
}
}
impl<const OPT: Options, M> Copy for Encoding<OPT, M> {}