Struct serde_urlencoded::Serializer

pub struct Serializer<'output, Target: 'output + UrlEncodedTarget> { /* fields omitted */ }

A serializer for the application/x-www-form-urlencoded format.

• Supported top-level inputs are structs, maps and sequences of pairs, with or without a given length.

• Supported keys and values are integers, bytes (if convertible to strings), unit structs and unit variants.

• Newtype structs defer to their inner values.

Methods

impl<'output, Target: 'output + UrlEncodedTarget> Serializer<'output, Target>

pub fn new(
    urlencoder: &'output mut UrlEncodedSerializer<'static, Target>
) -> Self

Returns a new Serializer.

Trait Implementations

impl<'output, Target> Serializer for Serializer<'output, Target> where
    Target: 'output + UrlEncodedTarget, 

type Ok = &'output mut UrlEncodedSerializer<'static, Target>

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 = SeqSerializer<'output, Target>

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

type SerializeTuple = TupleSerializer<'output, Target>

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

type SerializeTupleStruct = TupleStructSerializer<'output, Target>

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

type SerializeTupleVariant = TupleVariantSerializer<'output, Target>

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

type SerializeMap = MapSerializer<'output, Target>

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

type SerializeStruct = StructSerializer<'output, Target>

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

type SerializeStructVariant = StructVariantSerializer<'output, Target>

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

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Returns Ok.

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

Returns an error.

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

Serializes the inner value, ignoring the newtype name.

fn serialize_newtype_variant<T: ?Sized + Serialize>(
    self,
    _name: &'static str,
    _variant_index: u32,
    _variant: &'static str,
    _value: &T
) -> Result<Self::Ok, Error>

Returns an error.

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

Returns Ok.

fn serialize_some<T: ?Sized + Serialize>(
    self,
    value: &T
) -> Result<Self::Ok, Error>

Serializes the given value.

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

Serialize a sequence, given length (if any) is ignored.

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

Returns an error.

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

Returns an error.

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

Returns an error.

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

Serializes a map, given length is ignored.

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

Serializes a struct, given length is ignored.

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

Returns an error.

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.