Struct toml::Decoder

pub struct Decoder {
    pub toml: Option<Value>,
    // some fields omitted
}

A structure to transform TOML values into Rust values.

This decoder implements the serialization Decoder interface, allowing Decodable types to be generated by this decoder. The input is any arbitrary TOML value.

Fields

toml: Option<Value>

The TOML value left over after decoding. This can be used to inspect whether fields were decoded or not.

Implementations

impl Decoder

pub fn new(toml: Value) -> Decoder

Creates a new decoder, consuming the TOML value to decode.

This decoder can be passed to the Decodable methods or driven manually.

Trait Implementations

impl Decoder for Decoder

type Error = DecodeError

The error type for method results.

fn read_nil(&mut self) -> Result<(), DecodeError>

Read a nil value.

fn read_usize(&mut self) -> Result<usize, DecodeError>

Read a usize value.

fn read_u64(&mut self) -> Result<u64, DecodeError>

Read a u64 value.

fn read_u32(&mut self) -> Result<u32, DecodeError>

Read a u32 value.

fn read_u16(&mut self) -> Result<u16, DecodeError>

Read a u16 value.

fn read_u8(&mut self) -> Result<u8, DecodeError>

Read a u8 value.

fn read_isize(&mut self) -> Result<isize, DecodeError>

Read a isize value.

fn read_i64(&mut self) -> Result<i64, DecodeError>

Read a i64 value.

fn read_i32(&mut self) -> Result<i32, DecodeError>

Read a i32 value.

fn read_i16(&mut self) -> Result<i16, DecodeError>

Read a i16 value.

fn read_i8(&mut self) -> Result<i8, DecodeError>

Read a i8 value.

fn read_bool(&mut self) -> Result<bool, DecodeError>

Read a bool value.

fn read_f64(&mut self) -> Result<f64, DecodeError>

Read a f64 value.

fn read_f32(&mut self) -> Result<f32, DecodeError>

Read a f32 value.

fn read_char(&mut self) -> Result<char, DecodeError>

Read a char value.

fn read_str(&mut self) -> Result<String, DecodeError>

Read a string value.

fn read_enum<T, F>(&mut self, _name: &str, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read an enumeration value.

fn read_enum_variant<T, F>(
    &mut self,
    names: &[&str],
    f: F
) -> Result<T, DecodeError> where
    F: FnMut(&mut Decoder, usize) -> Result<T, DecodeError>, 

Read an enumeration value.

fn read_enum_variant_arg<T, F>(
    &mut self,
    _a_idx: usize,
    f: F
) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read an unnamed data item for an enumeration variant.

fn read_enum_struct_variant<T, F>(
    &mut self,
    _names: &[&str],
    _f: F
) -> Result<T, DecodeError> where
    F: FnMut(&mut Decoder, usize) -> Result<T, DecodeError>, 

Read an enumeration value.

fn read_enum_struct_variant_field<T, F>(
    &mut self,
    _f_name: &str,
    _f_idx: usize,
    _f: F
) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read a named data item for an enumeration variant.

fn read_struct<T, F>(
    &mut self,
    _s_name: &str,
    _len: usize,
    f: F
) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read an struct value.

fn read_struct_field<T, F>(
    &mut self,
    f_name: &str,
    _f_idx: usize,
    f: F
) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read a field for a struct value.

fn read_tuple<T, F>(&mut self, tuple_len: usize, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read a tuple value.

fn read_tuple_arg<T, F>(&mut self, a_idx: usize, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read a data item for a tuple.

fn read_tuple_struct<T, F>(
    &mut self,
    _s_name: &str,
    _len: usize,
    _f: F
) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read a tuple struct value.

fn read_tuple_struct_arg<T, F>(
    &mut self,
    _a_idx: usize,
    _f: F
) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read a data item for a tuple struct.

fn read_option<T, F>(&mut self, f: F) -> Result<T, DecodeError> where
    F: FnMut(&mut Decoder, bool) -> Result<T, DecodeError>, 

Read an optional value.

fn read_seq<T, F>(&mut self, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder, usize) -> Result<T, DecodeError>, 

Read a sequence of values.

fn read_seq_elt<T, F>(&mut self, idx: usize, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read an element in the sequence.

fn read_map<T, F>(&mut self, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder, usize) -> Result<T, DecodeError>, 

Read an associative container (map).

fn read_map_elt_key<T, F>(&mut self, idx: usize, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read the key for an entry in a map.

fn read_map_elt_val<T, F>(&mut self, idx: usize, f: F) -> Result<T, DecodeError> where
    F: FnOnce(&mut Decoder) -> Result<T, DecodeError>, 

Read the value for an entry in a map.

fn error(&mut self, err: &str) -> DecodeError

Record a decoding error.