SQLExpression

Enum SQLExpression 

Source
pub enum SQLExpression {
Show 18 variants ArrayLiteral(ArrayLiteral), Case(Case), Cast(Cast), Dot(Dot), FunctionCallApply(FunctionCallApply), Lambda(Lambda), Leaf(Leaf), OrderByExpression(OrderByExpression), RegexpCountFunction(RegexpCountFunction), RegexpExtractFunction(RegexpExtractFunction), ExtractFunction(ExtractFunction), RowLiteral(RowLiteral), BinaryOperatorApply(BinaryOperatorApply), SQLIndexLookup(IndexLookup), UnaryOperatorApply(UnaryOperatorApply), TryCast(TryCast), WindowExpression(WindowExpression), TupleLiteral(TupleLiteral),
}

Variants§

§

ArrayLiteral(ArrayLiteral)

§

Case(Case)

§

Cast(Cast)

§

Dot(Dot)

§

FunctionCallApply(FunctionCallApply)

§

Lambda(Lambda)

§

Leaf(Leaf)

§

OrderByExpression(OrderByExpression)

§

RegexpCountFunction(RegexpCountFunction)

§

RegexpExtractFunction(RegexpExtractFunction)

§

ExtractFunction(ExtractFunction)

§

RowLiteral(RowLiteral)

§

BinaryOperatorApply(BinaryOperatorApply)

§

SQLIndexLookup(IndexLookup)

§

UnaryOperatorApply(UnaryOperatorApply)

§

TryCast(TryCast)

§

WindowExpression(WindowExpression)

§

TupleLiteral(TupleLiteral)

Implementations§

Source§

impl SQLExpression

Source

pub fn try_unwrap_array_literal( self, ) -> Result<ArrayLiteral, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::ArrayLiteral variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_case(self) -> Result<Case, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::Case variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_cast(self) -> Result<Cast, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::Cast variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_dot(self) -> Result<Dot, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::Dot variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_function_call_apply( self, ) -> Result<FunctionCallApply, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::FunctionCallApply variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_lambda(self) -> Result<Lambda, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::Lambda variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_leaf(self) -> Result<Leaf, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::Leaf variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_order_by_expression( self, ) -> Result<OrderByExpression, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::OrderByExpression variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_regexp_count_function( self, ) -> Result<RegexpCountFunction, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::RegexpCountFunction variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_regexp_extract_function( self, ) -> Result<RegexpExtractFunction, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::RegexpExtractFunction variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_extract_function( self, ) -> Result<ExtractFunction, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::ExtractFunction variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_row_literal(self) -> Result<RowLiteral, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::RowLiteral variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_binary_operator_apply( self, ) -> Result<BinaryOperatorApply, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::BinaryOperatorApply variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_sql_index_lookup( self, ) -> Result<IndexLookup, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::SQLIndexLookup variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_unary_operator_apply( self, ) -> Result<UnaryOperatorApply, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::UnaryOperatorApply variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_try_cast(self) -> Result<TryCast, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::TryCast variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_window_expression( self, ) -> Result<WindowExpression, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::WindowExpression variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_tuple_literal( self, ) -> Result<TupleLiteral, TryUnwrapError<Self>>

Attempts to unwrap this value to the SQLExpression::TupleLiteral variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source§

impl SQLExpression

Source

pub fn unwrap_array_literal(self) -> ArrayLiteral

Unwraps this value to the SQLExpression::ArrayLiteral variant. Panics if this value is of any other type.

Source

pub fn unwrap_case(self) -> Case

Unwraps this value to the SQLExpression::Case variant. Panics if this value is of any other type.

Source

pub fn unwrap_cast(self) -> Cast

Unwraps this value to the SQLExpression::Cast variant. Panics if this value is of any other type.

Source

pub fn unwrap_dot(self) -> Dot

Unwraps this value to the SQLExpression::Dot variant. Panics if this value is of any other type.

Source

pub fn unwrap_function_call_apply(self) -> FunctionCallApply

Unwraps this value to the SQLExpression::FunctionCallApply variant. Panics if this value is of any other type.

Source

pub fn unwrap_lambda(self) -> Lambda

Unwraps this value to the SQLExpression::Lambda variant. Panics if this value is of any other type.

Source

pub fn unwrap_leaf(self) -> Leaf

Unwraps this value to the SQLExpression::Leaf variant. Panics if this value is of any other type.

Source

pub fn unwrap_order_by_expression(self) -> OrderByExpression

Unwraps this value to the SQLExpression::OrderByExpression variant. Panics if this value is of any other type.

Source

pub fn unwrap_regexp_count_function(self) -> RegexpCountFunction

Unwraps this value to the SQLExpression::RegexpCountFunction variant. Panics if this value is of any other type.

Source

pub fn unwrap_regexp_extract_function(self) -> RegexpExtractFunction

Unwraps this value to the SQLExpression::RegexpExtractFunction variant. Panics if this value is of any other type.

Source

pub fn unwrap_extract_function(self) -> ExtractFunction

Unwraps this value to the SQLExpression::ExtractFunction variant. Panics if this value is of any other type.

Source

pub fn unwrap_row_literal(self) -> RowLiteral

Unwraps this value to the SQLExpression::RowLiteral variant. Panics if this value is of any other type.

Source

pub fn unwrap_binary_operator_apply(self) -> BinaryOperatorApply

Unwraps this value to the SQLExpression::BinaryOperatorApply variant. Panics if this value is of any other type.

Source

pub fn unwrap_sql_index_lookup(self) -> IndexLookup

Unwraps this value to the SQLExpression::SQLIndexLookup variant. Panics if this value is of any other type.

Source

pub fn unwrap_unary_operator_apply(self) -> UnaryOperatorApply

Unwraps this value to the SQLExpression::UnaryOperatorApply variant. Panics if this value is of any other type.

Source

pub fn unwrap_try_cast(self) -> TryCast

Unwraps this value to the SQLExpression::TryCast variant. Panics if this value is of any other type.

Source

pub fn unwrap_window_expression(self) -> WindowExpression

Unwraps this value to the SQLExpression::WindowExpression variant. Panics if this value is of any other type.

Source

pub fn unwrap_tuple_literal(self) -> TupleLiteral

Unwraps this value to the SQLExpression::TupleLiteral variant. Panics if this value is of any other type.

Source§

impl SQLExpression

Source

pub fn get_column_references(&self) -> Vec<ColumnReference>

Source

pub fn dot(self, rhs: Identifier) -> SQLExpression

Source

pub fn index(self, index: SQLExpression) -> SQLExpression

Source

pub fn cast(self, type_: SQLType) -> SQLExpression

Source

pub fn fmt_indented(&self, f: &mut Formatter<'_>, indentation: usize) -> Result

Source

pub fn subelements(&self) -> usize

Source

pub fn map_leaves<F>(self, f: F) -> Self
where F: Clone + FnOnce(Leaf) -> SQLExpression,

Trait Implementations§

Source§

impl Clone for SQLExpression

Source§

fn clone(&self) -> SQLExpression

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SQLExpression

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SQLExpression

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ArrayLiteral> for SQLExpression

Source§

fn from(value: ArrayLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<BinaryLiteral> for SQLExpression

Source§

fn from(l: BinaryLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<BinaryOperatorApply> for SQLExpression

Source§

fn from(value: BinaryOperatorApply) -> Self

Converts to this type from the input type.
Source§

impl From<BooleanLiteral> for SQLExpression

Source§

fn from(l: BooleanLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<Case> for SQLExpression

Source§

fn from(value: Case) -> Self

Converts to this type from the input type.
Source§

impl From<Cast> for SQLExpression

Source§

fn from(value: Cast) -> Self

Converts to this type from the input type.
Source§

impl From<ColumnReference> for SQLExpression

Source§

fn from(l: ColumnReference) -> Self

Converts to this type from the input type.
Source§

impl From<DecimalLiteral> for SQLExpression

Source§

fn from(l: DecimalLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<Dot> for SQLExpression

Source§

fn from(value: Dot) -> Self

Converts to this type from the input type.
Source§

impl From<ExtractFunction> for SQLExpression

Source§

fn from(value: ExtractFunction) -> Self

Converts to this type from the input type.
Source§

impl From<FunctionCallApply> for SQLExpression

Source§

fn from(value: FunctionCallApply) -> Self

Converts to this type from the input type.
Source§

impl From<IndexLookup> for SQLExpression

Source§

fn from(value: IndexLookup) -> Self

Converts to this type from the input type.
Source§

impl From<IntegerLiteral> for SQLExpression

Source§

fn from(l: IntegerLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<IntervalLiteral> for SQLExpression

Source§

fn from(l: IntervalLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<Lambda> for SQLExpression

Source§

fn from(value: Lambda) -> Self

Converts to this type from the input type.
Source§

impl From<Leaf> for SQLExpression

Source§

fn from(value: Leaf) -> Self

Converts to this type from the input type.
Source§

impl From<NullLiteral> for SQLExpression

Source§

fn from(l: NullLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<OrderByExpression> for SQLExpression

Source§

fn from(value: OrderByExpression) -> Self

Converts to this type from the input type.
Source§

impl From<PatternVariableReference> for SQLExpression

Source§

fn from(l: PatternVariableReference) -> Self

Converts to this type from the input type.
Source§

impl From<RegexpCountFunction> for SQLExpression

Source§

fn from(value: RegexpCountFunction) -> Self

Converts to this type from the input type.
Source§

impl From<RegexpExtractFunction> for SQLExpression

Source§

fn from(value: RegexpExtractFunction) -> Self

Converts to this type from the input type.
Source§

impl From<RowLiteral> for SQLExpression

Source§

fn from(value: RowLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<ScientificLiteral> for SQLExpression

Source§

fn from(l: ScientificLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<StringLiteral> for SQLExpression

Source§

fn from(l: StringLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<TimestampLiteral> for SQLExpression

Source§

fn from(l: TimestampLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<TryCast> for SQLExpression

Source§

fn from(value: TryCast) -> Self

Converts to this type from the input type.
Source§

impl From<TupleLiteral> for SQLExpression

Source§

fn from(value: TupleLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<UnaryOperatorApply> for SQLExpression

Source§

fn from(value: UnaryOperatorApply) -> Self

Converts to this type from the input type.
Source§

impl From<UnicodeStringLiteral> for SQLExpression

Source§

fn from(l: UnicodeStringLiteral) -> Self

Converts to this type from the input type.
Source§

impl From<WindowExpression> for SQLExpression

Source§

fn from(value: WindowExpression) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SQLExpression

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for SQLExpression

Source§

impl StructuralPartialEq for SQLExpression

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyExt for T
where T: Any + ?Sized,

Source§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
Source§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
Source§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
Source§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
Source§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
Source§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

Source§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

Source§

fn coerce_box_to(self: Box<X>) -> Box<T>

Source§

fn coerce_ref_to(&self) -> &T

Source§

fn coerce_mut_to(&mut self) -> &mut T

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> Fmt for T
where T: Display,

Source§

fn fg<C>(self, color: C) -> Foreground<Self>
where C: Into<Option<Color>>, Self: Display,

Give this value the specified foreground colour.
Source§

fn bg<C>(self, color: C) -> Background<Self>
where C: Into<Option<Color>>, Self: Display,

Give this value the specified background colour.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

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>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.