musli_core/en/encode_bytes.rs
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
use crate::en::Encoder;
/// Trait governing how a type is encoded as bytes.
///
/// This is typically used automatically through the `#[musli(bytes)]` attribute
/// through the [`Encode` derive].
///
/// [`Encode` derive]: https://docs.rs/musli/latest/musli/help/derives/
///
/// # Examples
///
/// ```
/// use musli::Encode;
///
/// #[derive(Encode)]
/// struct MyType {
/// #[musli(bytes)]
/// data: [u8; 128],
/// }
/// ```
///
/// Implementing manually:
///
/// ```
/// use musli::{Encode, Encoder};
/// use musli::en::EncodeBytes;
///
/// struct MyType {
/// data: [u8; 128],
/// }
///
/// impl<M> Encode<M> for MyType {
/// fn encode<E>(&self, cx: &E::Cx, encoder: E) -> Result<E::Ok, E::Error>
/// where
/// E: Encoder,
/// {
/// self.data.encode_bytes(cx, encoder)
/// }
/// }
/// ```
pub trait EncodeBytes<M> {
/// Encode the given output as bytes.
fn encode_bytes<E>(&self, cx: &E::Cx, encoder: E) -> Result<E::Ok, E::Error>
where
E: Encoder<Mode = M>;
}
impl<T, M> EncodeBytes<M> for &T
where
T: ?Sized + EncodeBytes<M>,
{
#[inline]
fn encode_bytes<E>(&self, cx: &E::Cx, encoder: E) -> Result<E::Ok, E::Error>
where
E: Encoder<Mode = M>,
{
(**self).encode_bytes(cx, encoder)
}
}
impl<T, M> EncodeBytes<M> for &mut T
where
T: ?Sized + EncodeBytes<M>,
{
#[inline]
fn encode_bytes<E>(&self, cx: &E::Cx, encoder: E) -> Result<E::Ok, E::Error>
where
E: Encoder<Mode = M>,
{
(**self).encode_bytes(cx, encoder)
}
}