Struct Raw 

pub struct Raw<'a, F: RawFormat> { /* private fields */ }

A value encoded in the format F.

A raw value holds a value in the encoding of a format, for instance JSON text with deser_json::RawJson. It can be deserialized later (with deserialize), stored or written out again unchanged:

• If it’s deserialized from the format F, it holds the input of the value as it is. The format only validates the value and does not produce its events, which is fast. With the Borrowed adapter the input is borrowed.
• Otherwise (from another format or where the format cannot pass on the input, see below) the value is encoded in the format F. The encoding can lose information that F cannot express (bytes in JSON for instance). To keep a value of any format without interpreting it, use Recording.

When serialized with the format F, the encoded value is written as it is. Other formats serialize the value it holds.

The input of values can only be passed on if the format knows before the value starts that a raw value is wanted. Derived structs (for their first 64 fields), maps, sequences, Option and Box ask for it. Values in other places (like the fields of flattened structs, the variants of enums and values that are buffered, for instance for untagged enums) are encoded.

Like Cow, raw values are deserialized owned, so a Raw<'static, F> can be deserialized from any data.

Implementations

impl<'a, F: RawFormat> Raw<'a, F>

pub fn new<B: Into<Cow<'a, [u8]>>>(bytes: B) -> Result<Raw<'a, F>, Error>

Creates a raw value from its encoding.

The value is validated.

pub fn encode<T: Serialize + ?Sized>( value: &T, ) -> Result<Raw<'static, F>, Error>

Encodes a value.

pub fn as_bytes(&self) -> &[u8]

Returns the encoded value.

pub fn is_borrowed(&self) -> bool

Returns true if the value borrows from the data it was deserialized from.

pub fn replay<'x>( &'x self, sink: SinkHandle<'_, 'x>, state: &mut State, ) -> Result<(), Error>

Replays the value into a sink.

The value is parsed, the sink can borrow its data.

pub fn deserialize<'x, T: Deserialize<'x>>(&'x self) -> Result<T, Error>

Deserializes the value.

The value can borrow from the raw value (and the data it borrows).

pub fn into_owned(self) -> Raw<'static, F>

Detaches the value from the data it borrows.

impl<F: TextRawFormat> Raw<'_, F>

pub fn get(&self) -> &str

Returns the encoded value as text.

Trait Implementations

impl<F: RawFormat> Clone for Raw<'_, F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: RawFormat> Debug for Raw<'_, F>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a, F: RawFormat> Deserialize<'de, Raw<'a, F>> for Borrowed

Borrows raw values from the data if the format passes it on borrowed.

fn deserialize_into<'out>( out: &'out mut Option<Raw<'a, F>>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<'de, 'a, F: RawFormat> Deserialize<'de> for Raw<'a, F>

Raw values are deserialized owned so that Raw<'static, F> can be deserialized from any data. To borrow use the Borrowed adapter.

fn deserialize_into<'out>( out: &'out mut Option<Self>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<F: RawFormat> Eq for Raw<'_, F>

impl<F: RawFormat> Hash for Raw<'_, F>

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<F: RawFormat> PartialEq for Raw<'_, F>

Raw values are equal if their encodings are equal.

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<F: RawFormat> Serialize for Raw<'_, F>

Serialized with the format F, the encoded value is written as it is. Other formats serialize the value it holds.

fn serialize<'a>(value: &'a Self, state: &mut State) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

impl<'a, F: RawFormat> Serialize<Raw<'a, F>> for Borrowed

fn serialize<'x>( value: &'x Raw<'a, F>, state: &mut State, ) -> Result<Emit<'x>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.