Struct Input 

pub struct Input { /* private fields */ }

A named YAML text, ready to parse and validate.

Implementations

impl Input

pub fn new(name: impl Into<String>, text: impl Into<String>) -> Self

An input from text already in memory.

pub fn read(path: &Path) -> Result<Self, InputError>

Read a file, named by its path.

Errors

An InputError with the I/O failure.

pub fn name(&self) -> &str

The input’s name.

pub fn text(&self) -> &str

The input’s text.

pub fn frontmatter(&self) -> Option<(Self, &str)>

Split YAML frontmatter from a Markdown body: the text between a first line of --- and the next line of ---. Problems in the frontmatter keep the line numbers of the whole file. None when the text does not start with a --- line, or never closes it.

pub fn limits(self, limits: Limits) -> Self

Override limits for this input alone, above every other tier: see Limits for the order.

pub fn parse<T: DeserializeOwned>(&self) -> Result<T, InputError>

Parse the text’s shape. Only true and false are booleans, and a duplicate key or a merge key (<<) is refused. The text must fit the limits in force, field by field from this input, the repository’s REPO_FILE, the process default, and serde-saphyr’s own defaults.

Errors

An InputError with the parser’s problem and its line. A limit problem names the limit, its value, and where to raise it.

pub fn check<T: Validate + ?Sized>( &self, value: &T, context: &T::Context, ) -> Result<(), InputError>

Validate a parsed value against context, and place each of garde’s problems on the line of the field it names, or of its nearest written ancestor.

Errors

An InputError with every problem garde reports.

pub fn load<T>(&self) -> Result<T, InputError>

where T: DeserializeOwned + Validate, T::Context: Default,

Parse and validate with the default context.

Errors

As Input::parse and Input::check.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Input

impl PartialEq for Input

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Input