pub enum ErrType<'a> {
Show 33 variants
Custom(&'a str),
FsAlreadyExists,
FsDeadlock,
FsFileTooLarge,
FsInterrupted,
FsInvalidData,
FsInvalidFilename,
FsIsADirectory,
FsNotADirectory,
FsNotFound,
FsPermissionDenied,
FsOutOfMemory,
FsReadOnlyFilesystem,
FsStorageFull,
FsTimedOut,
InvalidInt,
InvalidFloat,
InvalidBool,
IndexOutOfBounds(usize, i64),
SliceOutOfBounds(usize, i64, i64),
UnknownMapKey(&'a str),
NullByteInString,
CArrayReturnTypeNotSupported,
InvalidReturnType(&'a DataType),
DivisionByZero,
ModuloByZero,
NegativeExponent(i64),
ShiftCountOutOfRange(i64),
JsonParse(&'static str),
BadDowncast(&'a str, &'static str),
HostFn(&'a str, &'a str),
NotAString(&'static str),
CallDepthExceeded(&'a str, usize),
}Expand description
Error types, largely borrowed from Rust
Variants§
Custom(&'a str)
FsAlreadyExists
FsDeadlock
FsFileTooLarge
FsInterrupted
FsInvalidData
FsInvalidFilename
FsIsADirectory
When a file was expected…
FsNotADirectory
When a directory was expected…
FsNotFound
FsPermissionDenied
FsOutOfMemory
FsReadOnlyFilesystem
FsStorageFull
FsTimedOut
InvalidInt
InvalidFloat
InvalidBool
IndexOutOfBounds(usize, i64)
IndexOutOfBounds(length, index)
SliceOutOfBounds(usize, i64, i64)
SliceOutOfBounds(length, idx_start, idx_end)
UnknownMapKey(&'a str)
NullByteInString
CArrayReturnTypeNotSupported
InvalidReturnType(&'a DataType)
DivisionByZero
ModuloByZero
NegativeExponent(i64)
An int raised to a negative int power, which has no int result.
The parser rejects the all-literal form; this is the run-time one.
ShiftCountOutOfRange(i64)
An int shifted by a negative count, or by 64 or more, which has no
int result. The parser and the compiler reject a count written as a
literal; this is the run-time one. Carries the count.
JsonParse(&'static str)
A json string could not be parsed. Carries a short static reason.
BadDowncast(&'a str, &'static str)
A downcast of an any value found a different runtime type than the
requested one. Carries (requested, found) type names.
HostFn(&'a str, &'a str)
A registered host function returned an error. Carries the name the script calls it by and the message the host reported.
NotAString(&'static str)
A string operation, a join or an ordering comparison, reached a value that is not a string, which only happens when a value arrived typed as a string and is not one. Carries the type name it turned out to have.
CallDepthExceeded(&'a str, usize)
A call that would stand one frame past the call-depth limit. Carries the name the call site wrote and the limit it reached.
Implementations§
Trait Implementations§
Source§impl From<IntErrorKind> for ErrType<'_>
impl From<IntErrorKind> for ErrType<'_>
Source§fn from(value: IntErrorKind) -> Self
fn from(value: IntErrorKind) -> Self
Auto Trait Implementations§
impl<'a> Freeze for ErrType<'a>
impl<'a> RefUnwindSafe for ErrType<'a>
impl<'a> Send for ErrType<'a>
impl<'a> Sync for ErrType<'a>
impl<'a> Unpin for ErrType<'a>
impl<'a> UnsafeUnpin for ErrType<'a>
impl<'a> UnwindSafe for ErrType<'a>
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
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§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);