#[non_exhaustive]pub enum ErrorKind<'v> {
Show 16 variants
InvalidLength {
min: Option<u64>,
max: Option<u64>,
},
InvalidChoice {
choices: Cow<'v, [Cow<'v, str>]>,
},
OutOfRange {
start: Option<isize>,
end: Option<isize>,
},
Validation(Cow<'v, str>),
Duplicate,
Missing,
Unexpected,
Unknown,
Custom(Status, Box<dyn Error + Send>),
Multipart(Error),
Utf8(Utf8Error),
Int(ParseIntError),
Bool(ParseBoolError),
Float(ParseFloatError),
Addr(AddrParseError),
Io(Error),
}
Expand description
The kind of form error that occurred.
Constructing
An ErrorKind
can be constructed directly or via a From
of the following
types:
(Option<u64>, Option<u64>)
=>ErrorKind::InvalidLength
(Option<ByteUnit>, Option<ByteUnit>)
=>ErrorKind::InvalidLength
(Option<isize>, Option<isize>)
=>ErrorKind::OutOfRange
&[Cow<'_, str>]
orVec<Cow<'_, str>>
=>ErrorKind::InvalidChoice
Utf8Error
=>ErrorKind::Utf8
ParseIntError
=>ErrorKind::Int
ParseFloatError
=>ErrorKind::Float
ParseBoolError
=>ErrorKind::Bool
AddrParseError
=>ErrorKind::Addr
io::Error
=>ErrorKind::Io
Box<dyn std::error::Error + Send
=>ErrorKind::Custom
(Status, Box<dyn std::error::Error + Send)
=>ErrorKind::Custom
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
InvalidLength
Fields
The value’s length, in bytes, was outside the range [min, max]
.
InvalidChoice
The value wasn’t one of the valid choices
.
OutOfRange
Fields
The integer value was outside the range [start, end]
.
Validation(Cow<'v, str>)
A custom validation routine failed with message .0
.
Duplicate
One entity was expected but more than one was received.
Missing
An entity was expected but was not received.
Unexpected
An unexpected entity was received.
Unknown
An unknown entity was received.
Custom(Status, Box<dyn Error + Send>)
A custom error occurred. Status defaults to
Status::UnprocessableEntity
if one is not directly specified.
Multipart(Error)
An error while parsing a multipart form occurred.
Utf8(Utf8Error)
A string was invalid UTF-8.
Int(ParseIntError)
A value failed to parse as an integer.
Bool(ParseBoolError)
A value failed to parse as a boolean.
Float(ParseFloatError)
A value failed to parse as a float.
Addr(AddrParseError)
A value failed to parse as an IP or socket address.
Io(Error)
An I/O error occurred.
Trait Implementations§
source§impl<'a> From<AddrParseError> for ErrorKind<'a>
impl<'a> From<AddrParseError> for ErrorKind<'a>
source§fn from(value: AddrParseError) -> Self
fn from(value: AddrParseError) -> Self
source§impl<'a> From<ParseBoolError> for ErrorKind<'a>
impl<'a> From<ParseBoolError> for ErrorKind<'a>
source§fn from(value: ParseBoolError) -> Self
fn from(value: ParseBoolError) -> Self
source§impl<'a> From<ParseFloatError> for ErrorKind<'a>
impl<'a> From<ParseFloatError> for ErrorKind<'a>
source§fn from(value: ParseFloatError) -> Self
fn from(value: ParseFloatError) -> Self
source§impl<'a> From<ParseIntError> for ErrorKind<'a>
impl<'a> From<ParseIntError> for ErrorKind<'a>
source§fn from(value: ParseIntError) -> Self
fn from(value: ParseIntError) -> Self
Auto Trait Implementations§
impl<'v> !RefUnwindSafe for ErrorKind<'v>
impl<'v> Send for ErrorKind<'v>
impl<'v> !Sync for ErrorKind<'v>
impl<'v> Unpin for ErrorKind<'v>
impl<'v> !UnwindSafe for ErrorKind<'v>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);