Struct FromStrBuilder 

pub struct FromStrBuilder { /* private fields */ }

A struct which will try to parse a string into a Value. This can be configured with custom parsers to extend what we’re able to parse into a Value.

Implementations

impl FromStrBuilder

pub fn add_custom_parser<F>(self, f: F) -> Self

where F: Fn(&mut &str) -> Option<Result<Value<()>, ParseError>> + 'static,

Add a custom parser. A custom parser is a function which is given a mutable string reference and will:

• return None if the string given is not applicable,
• return Some(Ok(value)) if we can successfully parse a value from the string. In this case, the parser should update the &mut str it’s given to consume however much was parsed.
• return Some(Err(error)) if the string given looks like a match, but something went wrong in trying to properly parse it. In this case, parsing will stop immediately and this error will be returned, so use this sparingly, as other parsers may be able to successfully parse what this one has failed to parse. No additional tokens will be consumed if an error occurs.

pub fn parse<'a>(&self, s: &'a str) -> (Result<Value<()>, ParseError>, &'a str)

Attempt to parse the string provided into a value, returning any error that occurred while attempting to do so, as well as the rest of the string that was not consumed by this parsing.