Struct validatron::error::ErrorBuilder

pub struct ErrorBuilder { /* private fields */ }

A convenience type for building a structured error type

Implementations

impl ErrorBuilder

pub fn contains_errors(&self) -> bool

does the builder contain any error messages, used to short circuit various functions if no error has been detected.

pub fn build(&mut self) -> Result<()>

Consume the builder and produce a Result

let e = Error::build()
    .at_named("a", "flat out broken")
    .build();
assert!(e.is_err());

pub fn at_location(
    &mut self,
    location: Location,
    message: impl Into<Cow<'static, str>>
) -> &mut Self

extend the existing builder with an error at the specified location

pub fn at_named(
    &mut self,
    name: impl Into<Cow<'static, str>>,
    message: impl Into<Cow<'static, str>>
) -> &mut Self

extend an existing builder with an error at a named location

let e = Error::build()
    .at_named("field_1", "should be empty")
    .build();

pub fn at_index(
    &mut self,
    index: usize,
    message: impl Into<Cow<'static, str>>
) -> &mut Self

extend an existing builder with an error at an indexed location

let e = Error::build()
    .at_index(1, "value should be even")
    .build();

pub fn try_at_location(
    &mut self,
    location: Location,
    result: Result<()>
) -> &mut Self

extend the existing builder at the specified location if the result is an error

let e = Error::build()
    .try_at_location(Location::Index(1), Ok(()))
    .build();
assert!(e.is_ok());

pub fn try_at_named(
    &mut self,
    name: impl Into<Cow<'static, str>>,
    result: Result<()>
) -> &mut Self

extend an existing builder with an error at a named location if the result is an error

let e = Error::build()
    .try_at_named("field", Ok(()))
    .build();
assert!(e.is_ok());

pub fn try_at_index(&mut self, index: usize, result: Result<()>) -> &mut Self

extend an existing builder with an error at an indexed location if the result is an error

let e = Error::build()
    .try_at_index(42, Ok(()))
    .build();
assert!(e.is_ok());