Struct docopt::Decoder
[−]
[src]
pub struct Decoder { /* fields omitted */ }
Decoder for ArgvMap
into your own Decodable
types.
In general, you shouldn't have to use this type directly. It is exposed in case you want to write a generic function that produces a decodable value. For example, here's a function that takes a usage string, an argv and produces a decodable value:
use docopt::Docopt; use rustc_serialize::Decodable; fn decode<D: Decodable>(usage: &str, argv: &[&str]) -> Result<D, docopt::Error> { Docopt::new(usage) .and_then(|d| d.argv(argv.iter().cloned()).decode()) }
Trait Implementations
impl Decoder for Decoder
[src]
type Error = Error
The error type for method results.
fn error(&mut self, err: &str) -> Error
Record a decoding error. Read more
fn read_nil(&mut self) -> Result<(), Error>
Read a nil value.
fn read_usize(&mut self) -> Result<usize, Error>
Read a usize value.
fn read_u64(&mut self) -> Result<u64, Error>
Read a u64 value.
fn read_u32(&mut self) -> Result<u32, Error>
Read a u32 value.
fn read_u16(&mut self) -> Result<u16, Error>
Read a u16 value.
fn read_u8(&mut self) -> Result<u8, Error>
Read a u8 value.
fn read_isize(&mut self) -> Result<isize, Error>
Read a isize value.
fn read_i64(&mut self) -> Result<i64, Error>
Read a i64 value.
fn read_i32(&mut self) -> Result<i32, Error>
Read a i32 value.
fn read_i16(&mut self) -> Result<i16, Error>
Read a i16 value.
fn read_i8(&mut self) -> Result<i8, Error>
Read a i8 value.
fn read_bool(&mut self) -> Result<bool, Error>
Read a bool value.
fn read_f64(&mut self) -> Result<f64, Error>
Read a f64 value.
fn read_f32(&mut self) -> Result<f32, Error>
Read a f32 value.
fn read_char(&mut self) -> Result<char, Error>
Read a char value.
fn read_str(&mut self) -> Result<String, Error>
Read a string value.
fn read_enum<T, F>(&mut self, _: &str, f: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read an enumeration value. Read more
fn read_enum_variant<T, F>(&mut self, names: &[&str], f: F) -> Result<T, Error> where
F: FnMut(&mut Decoder, usize) -> Result<T, Error>,
F: FnMut(&mut Decoder, usize) -> Result<T, Error>,
Read an enumeration value. Read more
fn read_enum_variant_arg<T, F>(&mut self, _: usize, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read an unnamed data item for an enumeration variant. Read more
fn read_enum_struct_variant<T, F>(
&mut self,
_: &[&str],
_: F
) -> Result<T, Error> where
F: FnMut(&mut Decoder, usize) -> Result<T, Error>,
&mut self,
_: &[&str],
_: F
) -> Result<T, Error> where
F: FnMut(&mut Decoder, usize) -> Result<T, Error>,
Read an enumeration value. Read more
fn read_enum_struct_variant_field<T, F>(
&mut self,
_: &str,
_: usize,
_: F
) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
&mut self,
_: &str,
_: usize,
_: F
) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read a named data item for an enumeration variant. Read more
fn read_struct<T, F>(&mut self, _: &str, _: usize, f: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read an struct value. Read more
fn read_struct_field<T, F>(
&mut self,
f_name: &str,
_: usize,
f: F
) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
&mut self,
f_name: &str,
_: usize,
f: F
) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read a field for a struct value. Read more
fn read_tuple<T, F>(&mut self, _: usize, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read a tuple value. Read more
fn read_tuple_arg<T, F>(&mut self, _: usize, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read a data item for a tuple. Read more
fn read_tuple_struct<T, F>(
&mut self,
_: &str,
_: usize,
_: F
) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
&mut self,
_: &str,
_: usize,
_: F
) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read a tuple struct value. Read more
fn read_tuple_struct_arg<T, F>(&mut self, _: usize, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read a data item for a tuple struct. Read more
fn read_option<T, F>(&mut self, f: F) -> Result<T, Error> where
F: FnMut(&mut Decoder, bool) -> Result<T, Error>,
F: FnMut(&mut Decoder, bool) -> Result<T, Error>,
Read an optional value. Read more
fn read_seq<T, F>(&mut self, f: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder, usize) -> Result<T, Error>,
F: FnOnce(&mut Decoder, usize) -> Result<T, Error>,
Read a sequence of values. Read more
fn read_seq_elt<T, F>(&mut self, _: usize, f: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read an element in the sequence. Read more
fn read_map<T, F>(&mut self, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder, usize) -> Result<T, Error>,
F: FnOnce(&mut Decoder, usize) -> Result<T, Error>,
Read an associative container (map). Read more
fn read_map_elt_key<T, F>(&mut self, _: usize, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read the key for an entry in a map. Read more
fn read_map_elt_val<T, F>(&mut self, _: usize, _: F) -> Result<T, Error> where
F: FnOnce(&mut Decoder) -> Result<T, Error>,
F: FnOnce(&mut Decoder) -> Result<T, Error>,
Read the value for an entry in a map. Read more