Struct Bytes 

#[repr(transparent)]
pub struct Bytes<T>(pub T);

Treat T as if its bytes.

This corresponds to the “Bytes” type in the data model of Müsli and is the equivalent of using #[musli(bytes)] on a field.

This is only implemented for type where the default behavior is not to pack the value already, this applies to types which implements EncodeBytes and DecodeBytes.

Examples

use musli::{Allocator, Decode, Decoder};
use musli::compat::Bytes;

struct Struct {
    field: Vec<u8>,
}

impl<'de, M, A> Decode<'de, M, A> for Struct
where
    A: Allocator,
    Bytes<Vec<u8>>: Decode<'de, M, A>
{
    #[inline]
    fn decode<D>(decoder: D) -> Result<Self, D::Error>
    where
        D: Decoder<'de, Mode = M, Allocator = A>,
    {
        let Bytes(field) = decoder.decode()?;

        Ok(Struct {
            field,
        })
    }
}

Tuple Fields

0: T

Trait Implementations

impl<T> AsMut<[u8]> for Bytes<T>

where T: AsMut<[u8]>,

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<[u8]> for Bytes<T>

where T: AsRef<[u8]>,

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Bytes<T>

fn clone(&self) -> Bytes<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Bytes<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T, A> Decode<'de, Binary, A> for Bytes<T>

where A: Allocator, T: EncodeBytes<Binary> + DecodeBytes<'de, Binary, A>,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'de>>::Error>

where T0: Decoder<'de, Mode = Binary, Allocator = A>,

Decode the current value.

impl<'de, T, A> Decode<'de, Text, A> for Bytes<T>

where A: Allocator, T: EncodeBytes<Text> + DecodeBytes<'de, Text, A>,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'de>>::Error>

where T0: Decoder<'de, Mode = Text, Allocator = A>,

Decode the current value.

impl<T> Encode<Binary> for Bytes<T>

where T: EncodeBytes<Binary>,

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Bytes<T>

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Binary>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl<T> Encode<Text> for Bytes<T>

where T: EncodeBytes<Text>,

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Bytes<T>

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Text>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl<T: Hash> Hash for Bytes<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Bytes<T>

fn cmp(&self, other: &Bytes<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Bytes<T>

fn eq(&self, other: &Bytes<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Bytes<T>

fn partial_cmp(&self, other: &Bytes<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy> Copy for Bytes<T>

impl<T: Eq> Eq for Bytes<T>

impl<T> StructuralPartialEq for Bytes<T>