Struct nbt::ser::Encoder

pub struct Encoder<'a, W> { /* fields omitted */ }

Encode objects to Named Binary Tag format.

This structure can be used to serialize objects which implement the serde::Serialize trait into NBT format. Note that not all types are representable in NBT format (notably unsigned integers), so this encoder may return errors.

Implementations

impl<'a, W> Encoder<'a, W> where
    W: Write, 

pub fn new(writer: W, header: Option<&'a str>) -> Self

Create an encoder with optional header from a given Writer.

Trait Implementations

impl<'a, 'b, W> Serializer for &'a mut Encoder<'b, W> where
    W: Write, 

type Ok = ()

The output type produced by this Serializer during successful serialization. Most serializers that produce text or binary output should set Ok = () and serialize into an [io::Write] or buffer contained within the Serializer instance. Serializers that build in-memory data structures may be simplified by using Ok to propagate the data structure around.

type Error = Error

The error type when some error occurs during serialization.

type SerializeSeq = Impossible<(), Error>

Type returned from [serialize_seq] for serializing the content of the sequence.

type SerializeTuple = Impossible<(), Error>

Type returned from [serialize_tuple] for serializing the content of the tuple.

type SerializeTupleStruct = Impossible<(), Error>

Type returned from [serialize_tuple_struct] for serializing the content of the tuple struct.

type SerializeTupleVariant = Impossible<(), Error>

Type returned from [serialize_tuple_variant] for serializing the content of the tuple variant.

type SerializeMap = Compound<'a, 'b, W>

Type returned from [serialize_map] for serializing the content of the map.

type SerializeStruct = Compound<'a, 'b, W>

Type returned from [serialize_struct] for serializing the content of the struct.

type SerializeStructVariant = Impossible<(), Error>

Type returned from [serialize_struct_variant] for serializing the content of the struct variant.

fn serialize_bool(self, _: bool) -> Result<Self::Ok, Self::Error>

Serialize a bool value.

fn serialize_i8(self, _: i8) -> Result<Self::Ok, Self::Error>

Serialize an i8 value.

fn serialize_i16(self, _: i16) -> Result<Self::Ok, Self::Error>

Serialize an i16 value.

fn serialize_i32(self, _: i32) -> Result<Self::Ok, Self::Error>

Serialize an i32 value.

fn serialize_i64(self, _: i64) -> Result<Self::Ok, Self::Error>

Serialize an i64 value.

fn serialize_u8(self, _: u8) -> Result<Self::Ok, Self::Error>

Serialize a u8 value.

fn serialize_u16(self, _: u16) -> Result<Self::Ok, Self::Error>

Serialize a u16 value.

fn serialize_u32(self, _: u32) -> Result<Self::Ok, Self::Error>

Serialize a u32 value.

fn serialize_u64(self, _: u64) -> Result<Self::Ok, Self::Error>

Serialize a u64 value.

fn serialize_f32(self, _: f32) -> Result<Self::Ok, Self::Error>

Serialize an f32 value.

fn serialize_f64(self, _: f64) -> Result<Self::Ok, Self::Error>

Serialize an f64 value.

fn serialize_char(self, _: char) -> Result<Self::Ok, Self::Error>

Serialize a character.

fn serialize_str(self, _: &str) -> Result<Self::Ok, Self::Error>

Serialize a &str.

fn serialize_bytes(self, _: &[u8]) -> Result<Self::Ok, Self::Error>

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<Self::Ok, Self::Error>

Serialize a [None] value.

fn serialize_some<__T: ?Sized>(self, _: &__T) -> Result<Self::Ok, Self::Error> where
    __T: Serialize, 

Serialize a [Some(T)] value.

fn serialize_unit(self) -> Result<Self::Ok, Self::Error>

Serialize a () value.

fn serialize_unit_variant(
    self,
    _: &'static str,
    _: u32,
    _: &'static str
) -> Result<Self::Ok, Self::Error>

Serialize a unit variant like E::A in enum E { A, B }.

fn serialize_newtype_variant<__T: ?Sized>(
    self,
    _: &'static str,
    _: u32,
    _: &'static str,
    _: &__T
) -> Result<Self::Ok, Self::Error> where
    __T: Serialize, 

Serialize a newtype variant like E::N in enum E { N(u8) }.

fn serialize_seq(
    self,
    _: Option<usize>
) -> Result<Self::SerializeSeq, Self::Error>

Begin to serialize a variably sized sequence. This call must be followed by zero or more calls to serialize_element, then a call to end.

fn serialize_tuple(self, _: usize) -> Result<Self::SerializeTuple, Self::Error>

Begin to serialize a statically sized sequence whose length will be known at deserialization time without looking at the serialized data. This call must be followed by zero or more calls to serialize_element, then a call to end.

fn serialize_tuple_struct(
    self,
    _: &'static str,
    _: usize
) -> Result<Self::SerializeTupleStruct, Self::Error>

Begin to serialize a tuple struct like struct Rgb(u8, u8, u8). This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_tuple_variant(
    self,
    _: &'static str,
    _: u32,
    _: &'static str,
    _: usize
) -> Result<Self::SerializeTupleVariant, Self::Error>

Begin to serialize a tuple variant like E::T in enum E { T(u8, u8) }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_struct_variant(
    self,
    _: &'static str,
    _: u32,
    _: &'static str,
    _: usize
) -> Result<Self::SerializeStructVariant, Self::Error>

Begin to serialize a struct variant like E::S in enum E { S { r: u8, g: u8, b: u8 } }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_unit_struct(self, _name: &'static str) -> Result<()>

Serialize unit structs as empty Tag_Compound data.

fn serialize_newtype_struct<T: ?Sized>(
    self,
    _name: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize, 

Serialize newtype structs by their underlying type. Note that this will only be successful if the underyling type is a struct or a map.

fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap>

Serialize maps as Tag_Compound data.

fn serialize_struct(
    self,
    _name: &'static str,
    _len: usize
) -> Result<Self::SerializeStruct>

Serialize structs as Tag_Compound data.

fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>

Serialize an i128 value.

fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error>

Serialize a u128 value.

fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Serialize, 

Collect an iterator as a sequence.

fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
    I: IntoIterator<Item = (K, V)>,
    K: Serialize,
    V: Serialize, 

Collect an iterator as a map.

fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error> where
    T: Display + ?Sized, 

Serialize a string produced by an implementation of Display.

fn is_human_readable(&self) -> bool

Determine whether Serialize implementations should serialize in human-readable form.