gluesql::core::ast_builder

Enum ExprNode

Source 
pub enum ExprNode<'a> {

Show 20 variants    Expr(Cow<'a, Expr>),
    SqlExpr(Cow<'a, str>),
    Identifier(Cow<'a, str>),
    Numeric(NumericNode<'a>),
    QuotedString(Cow<'a, str>),
    TypedString {
        data_type: DataType,
        value: Cow<'a, str>,
    },
    Between {
        expr: Box<ExprNode<'a>>,
        negated: bool,
        low: Box<ExprNode<'a>>,
        high: Box<ExprNode<'a>>,
    },
    Like {
        expr: Box<ExprNode<'a>>,
        negated: bool,
        pattern: Box<ExprNode<'a>>,
    },
    ILike {
        expr: Box<ExprNode<'a>>,
        negated: bool,
        pattern: Box<ExprNode<'a>>,
    },
    BinaryOp {
        left: Box<ExprNode<'a>>,
        op: BinaryOperator,
        right: Box<ExprNode<'a>>,
    },
    UnaryOp {
        op: UnaryOperator,
        expr: Box<ExprNode<'a>>,
    },
    IsNull(Box<ExprNode<'a>>),
    IsNotNull(Box<ExprNode<'a>>),
    InList {
        expr: Box<ExprNode<'a>>,
        list: Box<InListNode<'a>>,
        negated: bool,
    },
    Nested(Box<ExprNode<'a>>),
    Function(Box<FunctionNode<'a>>),
    Aggregate(Box<AggregateNode<'a>>),
    Exists {
        subquery: Box<QueryNode<'a>>,
        negated: bool,
    },
    Subquery(Box<QueryNode<'a>>),
    Case {
        operand: Option<Box<ExprNode<'a>>>,
        when_then: Vec<(ExprNode<'a>, ExprNode<'a>)>,
        else_result: Option<Box<ExprNode<'a>>>,
    },

}

Variants§

§

Expr(Cow<'a, Expr>)

§

SqlExpr(Cow<'a, str>)

§

Identifier(Cow<'a, str>)

§

Numeric(NumericNode<'a>)

§

QuotedString(Cow<'a, str>)

§

TypedString

Fields

§data_type: DataType
§value: Cow<'a, str>
§

Between

Fields

§expr: Box<ExprNode<'a>>
§negated: bool
§low: Box<ExprNode<'a>>
§high: Box<ExprNode<'a>>
§

Like

Fields

§expr: Box<ExprNode<'a>>
§negated: bool
§pattern: Box<ExprNode<'a>>
§

ILike

Fields

§expr: Box<ExprNode<'a>>
§negated: bool
§pattern: Box<ExprNode<'a>>
§

BinaryOp

Fields

§left: Box<ExprNode<'a>>
§op: BinaryOperator
§right: Box<ExprNode<'a>>
§

UnaryOp

Fields

§op: UnaryOperator
§expr: Box<ExprNode<'a>>
§

IsNull(Box<ExprNode<'a>>)

§

IsNotNull(Box<ExprNode<'a>>)

§

InList

Fields

§expr: Box<ExprNode<'a>>
§list: Box<InListNode<'a>>
§negated: bool
§

Nested(Box<ExprNode<'a>>)

§

Function(Box<FunctionNode<'a>>)

§

Aggregate(Box<AggregateNode<'a>>)

§

Exists

Fields

§subquery: Box<QueryNode<'a>>
§negated: bool
§

Subquery(Box<QueryNode<'a>>)

§

Case

Fields

§operand: Option<Box<ExprNode<'a>>>
§when_then: Vec<(ExprNode<'a>, ExprNode<'a>)>
§else_result: Option<Box<ExprNode<'a>>>

Implementations§

Source§

impl<'a> ExprNode<'a>

Source

pub fn add<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn sub<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn mul<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn div<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn modulo<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn concat<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn gt<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn lt<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn gte<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn lte<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn eq<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn neq<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn and<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn or<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn bitwise_and<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn bitwise_shift_left<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn bitwise_shift_right<T>(self, other: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source§

impl<'a> ExprNode<'a>

Source

pub fn case(self) -> CaseNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn is_null(self) -> ExprNode<'a>

Source

pub fn is_not_null(self) -> ExprNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn like<T>(self, pattern: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn ilike<T>(self, pattern: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn not_like<T>(self, pattern: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn not_ilike<T>(self, pattern: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source§

impl<'a> ExprNode<'a>

Source

pub fn nested(self) -> ExprNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn plus(self) -> ExprNode<'a>

Source

pub fn minus(self) -> ExprNode<'a>

Source

pub fn negate(self) -> ExprNode<'a>

Source

pub fn factorial(self) -> ExprNode<'a>

Source

pub fn bitwise_not(self) -> ExprNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn count(self) -> ExprNode<'a>

Source

pub fn sum(self) -> ExprNode<'a>

Source

pub fn min(self) -> ExprNode<'a>

Source

pub fn max(self) -> ExprNode<'a>

Source

pub fn avg(self) -> ExprNode<'a>

Source

pub fn variance(self) -> ExprNode<'a>

Source

pub fn stdev(self) -> ExprNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn alias_as(self, alias: &str) -> ExprWithAliasNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn between<T, U>(self, low: T, high: U) -> ExprNode<'a>
where T: Into<ExprNode<'a>>, U: Into<ExprNode<'a>>,

Source

pub fn not_between<T, U>(self, low: T, high: U) -> ExprNode<'a>
where T: Into<ExprNode<'a>>, U: Into<ExprNode<'a>>,

Source§

impl<'a> ExprNode<'a>

Source

pub fn abs(self) -> ExprNode<'a>

Source

pub fn upper(self) -> ExprNode<'a>

Source

pub fn lower(self) -> ExprNode<'a>

Source

pub fn initcap(self) -> ExprNode<'a>

Source

pub fn ifnull<T>(self, another: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn ceil(self) -> ExprNode<'a>

Source

pub fn rand(self) -> ExprNode<'a>

Source

pub fn round(self) -> ExprNode<'a>

Source

pub fn floor(self) -> ExprNode<'a>

Source

pub fn asin(self) -> ExprNode<'a>

Source

pub fn acos(self) -> ExprNode<'a>

Source

pub fn atan(self) -> ExprNode<'a>

Source

pub fn sin(self) -> ExprNode<'a>

Source

pub fn cos(self) -> ExprNode<'a>

Source

pub fn tan(self) -> ExprNode<'a>

Source

pub fn left<T>(self, size: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn log<T>(self, base: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn log2(self) -> ExprNode<'a>

Source

pub fn log10(self) -> ExprNode<'a>

Source

pub fn ln(self) -> ExprNode<'a>

Source

pub fn right<T>(self, size: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn reverse(self) -> ExprNode<'a>

Source

pub fn sign(self) -> ExprNode<'a>

Source

pub fn skip<T>(self, size: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn power<T>(self, pwr: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn sqrt(self) -> ExprNode<'a>

Source

pub fn gcd<T>(self, right: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn lcm<T>(self, right: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn repeat<T>(self, num: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn replace<T, U>(self, old: T, new: U) -> ExprNode<'a>
where T: Into<ExprNode<'a>>, U: Into<ExprNode<'a>>,

Source

pub fn degrees(self) -> ExprNode<'a>

Source

pub fn radians(self) -> ExprNode<'a>

Source

pub fn lpad<T>(self, size: T, fill: Option<ExprNode<'a>>) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn rpad<T>(self, size: T, fill: Option<ExprNode<'a>>) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn take<T>(self, size: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn exp(self) -> ExprNode<'a>

Source

pub fn substr<T>(self, start: T, count: Option<ExprNode<'a>>) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn rtrim(self, chars: Option<ExprNode<'a>>) -> ExprNode<'a>

Source

pub fn ltrim(self, chars: Option<ExprNode<'a>>) -> ExprNode<'a>

Source

pub fn format<T>(self, fmt: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn to_date<T>(self, format: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn to_timestamp<T>(self, format: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn to_time<T>(self, format: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn position<T>(self, format: T) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn find_idx<T>(self, sub: T, start: Option<ExprNode<'a>>) -> ExprNode<'a>
where T: Into<ExprNode<'a>>,

Source

pub fn cast<T>(self, data_type: T) -> ExprNode<'a>
where T: Into<DataTypeNode>,

Source

pub fn extract(self, field: DateTimeField) -> ExprNode<'a>

Source

pub fn is_empty(self) -> ExprNode<'a>

Source

pub fn last_day(self) -> ExprNode<'a>

Source

pub fn entries(self) -> ExprNode<'a>

Source

pub fn keys(self) -> ExprNode<'a>

Source

pub fn values(self) -> ExprNode<'a>

Source§

impl<'a> ExprNode<'a>

Source

pub fn in_list<T>(self, value: T) -> ExprNode<'a>
where T: Into<InListNode<'a>>,

Source

pub fn not_in_list<T>(self, value: T) -> ExprNode<'a>
where T: Into<InListNode<'a>>,

Trait Implementations§

Source§

impl<'a> Clone for ExprNode<'a>

Source§

fn clone(&self) -> ExprNode<'a>

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<'a> Debug for ExprNode<'a>

Source§

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

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

impl<'a> From<&'a Expr> for ExprNode<'a>

Source§

fn from(expr: &'a Expr) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<&'a str> for ExprNode<'a>

Source§

fn from(expr: &'a str) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<Expr> for ExprNode<'a>

Source§

fn from(expr: Expr) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<ExprNode<'a>> for OrderByExprList<'a>

Source§

fn from(expr_node: ExprNode<'a>) -> OrderByExprList<'a>

Converts to this type from the input type.
Source§

impl<'a> From<ExprNode<'a>> for OrderByExprNode<'a>

Source§

fn from(expr_node: ExprNode<'a>) -> OrderByExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<ExprNode<'a>> for SelectItemList<'a>

Source§

fn from(expr_node: ExprNode<'a>) -> SelectItemList<'a>

Converts to this type from the input type.
Source§

impl<'a> From<ExprNode<'a>> for SelectItemNode<'a>

Source§

fn from(expr_node: ExprNode<'a>) -> SelectItemNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<QueryNode<'a>> for ExprNode<'a>

Source§

fn from(node: QueryNode<'a>) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<String> for ExprNode<'a>

Source§

fn from(expr: String) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<bool> for ExprNode<'a>

Source§

fn from(b: bool) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> From<i64> for ExprNode<'a>

Source§

fn from(n: i64) -> ExprNode<'a>

Converts to this type from the input type.
Source§

impl<'a> TryFrom<ExprNode<'a>> for Expr

Source§

type Error = Error

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

fn try_from(expr_node: ExprNode<'a>) -> Result<Expr, Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<'a> Freeze for ExprNode<'a>

§

impl<'a> RefUnwindSafe for ExprNode<'a>

§

impl<'a> Send for ExprNode<'a>

§

impl<'a> Sync for ExprNode<'a>

§

impl<'a> Unpin for ExprNode<'a>

§

impl<'a> UnwindSafe for ExprNode<'a>

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> 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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> ErasedDestructor for T
where T: 'static,