Enum BinaryFunc

Source

pub enum BinaryFunc {
Show 194 variants    AddInt16,
    AddInt32,
    AddInt64,
    AddUInt16,
    AddUInt32,
    AddUInt64,
    AddFloat32,
    AddFloat64,
    AddInterval,
    AddTimestampInterval,
    AddTimestampTzInterval,
    AddDateInterval,
    AddDateTime,
    AddTimeInterval,
    AddNumeric,
    AgeTimestamp,
    AgeTimestampTz,
    BitAndInt16,
    BitAndInt32,
    BitAndInt64,
    BitAndUInt16,
    BitAndUInt32,
    BitAndUInt64,
    BitOrInt16,
    BitOrInt32,
    BitOrInt64,
    BitOrUInt16,
    BitOrUInt32,
    BitOrUInt64,
    BitXorInt16,
    BitXorInt32,
    BitXorInt64,
    BitXorUInt16,
    BitXorUInt32,
    BitXorUInt64,
    BitShiftLeftInt16,
    BitShiftLeftInt32,
    BitShiftLeftInt64,
    BitShiftLeftUInt16,
    BitShiftLeftUInt32,
    BitShiftLeftUInt64,
    BitShiftRightInt16,
    BitShiftRightInt32,
    BitShiftRightInt64,
    BitShiftRightUInt16,
    BitShiftRightUInt32,
    BitShiftRightUInt64,
    SubInt16,
    SubInt32,
    SubInt64,
    SubUInt16,
    SubUInt32,
    SubUInt64,
    SubFloat32,
    SubFloat64,
    SubInterval,
    SubTimestamp,
    SubTimestampTz,
    SubTimestampInterval,
    SubTimestampTzInterval,
    SubDate,
    SubDateInterval,
    SubTime,
    SubTimeInterval,
    SubNumeric,
    MulInt16,
    MulInt32,
    MulInt64,
    MulUInt16,
    MulUInt32,
    MulUInt64,
    MulFloat32,
    MulFloat64,
    MulNumeric,
    MulInterval,
    DivInt16,
    DivInt32,
    DivInt64,
    DivUInt16,
    DivUInt32,
    DivUInt64,
    DivFloat32,
    DivFloat64,
    DivNumeric,
    DivInterval,
    ModInt16,
    ModInt32,
    ModInt64,
    ModUInt16,
    ModUInt32,
    ModUInt64,
    ModFloat32,
    ModFloat64,
    ModNumeric,
    RoundNumeric,
    Eq,
    NotEq,
    Lt,
    Lte,
    Gt,
    Gte,
    LikeEscape,
    IsLikeMatch {
        case_insensitive: bool,
    },
    IsRegexpMatch {
        case_insensitive: bool,
    },
    ToCharTimestamp,
    ToCharTimestampTz,
    DateBinTimestamp,
    DateBinTimestampTz,
    ExtractInterval,
    ExtractTime,
    ExtractTimestamp,
    ExtractTimestampTz,
    ExtractDate,
    DatePartInterval,
    DatePartTime,
    DatePartTimestamp,
    DatePartTimestampTz,
    DateTruncTimestamp,
    DateTruncTimestampTz,
    DateTruncInterval,
    TimezoneTimestamp,
    TimezoneTimestampTz,
    TimezoneIntervalTimestamp,
    TimezoneIntervalTimestampTz,
    TimezoneIntervalTime,
    TimezoneOffset,
    TextConcat,
    JsonbGetInt64,
    JsonbGetInt64Stringify,
    JsonbGetString,
    JsonbGetStringStringify,
    JsonbGetPath,
    JsonbGetPathStringify,
    JsonbContainsString,
    JsonbConcat,
    JsonbContainsJsonb,
    JsonbDeleteInt64,
    JsonbDeleteString,
    MapContainsKey,
    MapGetValue,
    MapContainsAllKeys,
    MapContainsAnyKeys,
    MapContainsMap,
    ConvertFrom,
    Left,
    Position,
    Right,
    RepeatString,
    Trim,
    TrimLeading,
    TrimTrailing,
    EncodedBytesCharLength,
    ListLengthMax {
        max_layer: usize,
    },
    ArrayContains,
    ArrayContainsArray {
        rev: bool,
    },
    ArrayLength,
    ArrayLower,
    ArrayRemove,
    ArrayUpper,
    ArrayArrayConcat,
    ListListConcat,
    ListElementConcat,
    ElementListConcat,
    ListRemove,
    ListContainsList {
        rev: bool,
    },
    DigestString,
    DigestBytes,
    MzRenderTypmod,
    Encode,
    Decode,
    LogNumeric,
    Power,
    PowerNumeric,
    GetBit,
    GetByte,
    ConstantTimeEqBytes,
    ConstantTimeEqString,
    RangeContainsElem {
        elem_type: ScalarType,
        rev: bool,
    },
    RangeContainsRange {
        rev: bool,
    },
    RangeOverlaps,
    RangeAfter,
    RangeBefore,
    RangeOverleft,
    RangeOverright,
    RangeAdjacent,
    RangeUnion,
    RangeIntersection,
    RangeDifference,
    UuidGenerateV5,
    MzAclItemContainsPrivilege,
    ParseIdent,
    PrettySql,
    RegexpReplace {
        regex: Regex,
        limit: usize,
    },
    StartsWith,
}

Variants§

§

IsLikeMatch

Fields

§case_insensitive: bool

§

IsRegexpMatch

Fields

§case_insensitive: bool

§

ToCharTimestamp

§

ToCharTimestampTz

§

DateBinTimestamp

§

DateBinTimestampTz

§

ExtractInterval

§

ExtractTime

§

ExtractTimestamp

§

ExtractTimestampTz

§

ExtractDate

§

DatePartInterval

§

DatePartTime

§

DatePartTimestamp

§

DatePartTimestampTz

§

DateTruncTimestamp

§

DateTruncTimestampTz

§

DateTruncInterval

§

TimezoneTimestamp

§

TimezoneTimestampTz

§

TimezoneIntervalTimestamp

§

TimezoneIntervalTimestampTz

§

TimezoneIntervalTime

§

TimezoneOffset

§

TextConcat

§

JsonbGetInt64

§

JsonbGetInt64Stringify

§

JsonbGetString

§

JsonbGetStringStringify

§

JsonbGetPath

§

JsonbGetPathStringify

§

JsonbContainsString

§

JsonbConcat

§

JsonbContainsJsonb

§

JsonbDeleteInt64

§

JsonbDeleteString

§

MapContainsKey

§

MapGetValue

§

MapContainsAllKeys

§

MapContainsAnyKeys

§

MapContainsMap

§

ConvertFrom

§

Left

§

Position

§

Right

§

RepeatString

§

Trim

§

TrimLeading

§

TrimTrailing

§

EncodedBytesCharLength

§

ListLengthMax

Fields

§max_layer: usize

§

ArrayContains

§

ArrayContainsArray

Fields

§rev: bool

§

ArrayLength

§

ArrayLower

§

ArrayRemove

§

ArrayUpper

§

ArrayArrayConcat

§

ListListConcat

§

ListElementConcat

§

ElementListConcat

§

ListRemove

§

ListContainsList

Fields

§rev: bool

§

DigestString

§

DigestBytes

§

MzRenderTypmod

§

Encode

§

Decode

§

LogNumeric

§

Power

§

PowerNumeric

§

GetBit

§

GetByte

§

ConstantTimeEqBytes

§

ConstantTimeEqString

§

RangeContainsElem

Fields

§elem_type: ScalarType

§rev: bool

§

RangeContainsRange

Fields

§rev: bool

§

RangeOverlaps

§

RangeAfter

§

RangeBefore

§

RangeOverleft

§

RangeOverright

§

RangeAdjacent

§

RangeUnion

§

RangeIntersection

§

RangeDifference

§

UuidGenerateV5

§

MzAclItemContainsPrivilege

§

ParseIdent

§

PrettySql

§

RegexpReplace

Fields

§regex: Regex

§limit: usize

§

StartsWith

Implementations§

Source §

impl BinaryFunc

Source

pub fn eval<'a>( &'a self, datums: &[Datum<'a>], temp_storage: &'a RowArena, a_expr: &'a MirScalarExpr, b_expr: &'a MirScalarExpr, ) -> Result<Datum<'a>, EvalError>

Source

pub fn output_type( &self, input1_type: ColumnType, input2_type: ColumnType, ) -> ColumnType

Source

pub fn propagates_nulls(&self) -> bool

Whether the function output is NULL if any of its inputs are NULL.

Source

pub fn introduces_nulls(&self) -> bool

Whether the function might return NULL even if none of its inputs are NULL.

This is presently conservative, and may indicate that a function introduces nulls even when it does not.

Source

pub fn is_infix_op(&self) -> bool

Source

pub fn negate(&self) -> Option<Self>

Returns the negation of the given binary function, if it exists.

Source

pub fn could_error(&self) -> bool

Returns true if the function could introduce an error on non-error inputs.

Source

pub fn is_monotone(&self) -> (bool, bool)

Returns true if the function is monotone. (Non-strict; either increasing or decreasing.) Monotone functions map ranges to ranges: ie. given a range of possible inputs, we can determine the range of possible outputs just by mapping the endpoints.

This describes the pointwise behaviour of the function: ie. the behaviour of any specific argument as the others are held constant. (For example, a - b is monotone in the first argument because for any particular value of b, increasing a will always cause the result to increase… and in the second argument because for any specific a, increasing b will always cause the result to decrease.)

This property describes the behaviour of the function over ranges where the function is defined: ie. the arguments and the result are non-error datums.

Trait Implementations§

Source §

impl Arbitrary for BinaryFunc

An explicit Arbitrary implementation needed here because of a known proptest issue.

Revert to the derive-macro impementation once the issue¹ is fixed.

https://github.com/AltSysrq/proptest/issues/152 ↩

Source §

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

Source §

type Strategy = Union<BoxedStrategy<BinaryFunc>>

The type of Strategy used to generate values of type Self.

Source §

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more

Source §

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more

Source §

impl Clone for BinaryFunc

Source §

fn clone(&self) -> BinaryFunc

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 BinaryFunc

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for BinaryFunc

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Display for BinaryFunc

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Hash for BinaryFunc

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl MzReflect for BinaryFunc

Source §

fn add_to_reflected_type_info(rti: &mut ReflectedTypeInfo)

Adds names and types of the fields of the struct or enum to rti. Read more

Source §

impl Ord for BinaryFunc

Source §

fn cmp(&self, other: &BinaryFunc) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for BinaryFunc

Source §

fn eq(&self, other: &BinaryFunc) -> 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 PartialOrd for BinaryFunc

Source §

fn partial_cmp(&self, other: &BinaryFunc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

impl RustType<ProtoBinaryFunc> for BinaryFunc

Source §

fn into_proto(&self) -> ProtoBinaryFunc

Convert a Self into a Proto value.

Source §

fn from_proto(proto: ProtoBinaryFunc) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value. Read more

Source §

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

Source §

impl Serialize for BinaryFunc

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Source §

impl Eq for BinaryFunc

Source §

impl StructuralPartialEq for BinaryFunc

Auto Trait Implementations§

§

impl Freeze for BinaryFunc

§

impl RefUnwindSafe for BinaryFunc

§

impl Send for BinaryFunc

§

impl Sync for BinaryFunc

§

impl Unpin for BinaryFunc

§

impl UnwindSafe for BinaryFunc

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, U> CastInto for T
where U: CastFrom<T>,

Source §

fn cast_into(self) -> U

Performs the cast.

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

Source §

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

Source §

fn __clone_box(&self, _: Private) -> *mut ()

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

Source §

impl<T> FutureExt for T

Source §

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

Source §

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

Source §

impl<T> Hashable for T
where T: Hash,

Source §

type Output = u64

The type of the output value.

Source §

fn hashed(&self) -> u64

A well-distributed integer derived from the data.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoRequest<T> for T

Source §

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

Source §

impl<T, U> OverrideFrom<Option<&T>> for U
where U: OverrideFrom<T>,

Source §

fn override_from(self, layer: &Option<&T>) -> U

Override the configuration represented by Self with values from the given layer.

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());

Source §

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

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

§Example

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

Source §

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

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> 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> PolicyExt for T
where T: ?Sized,

Source §

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

Source §

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

Source §

impl<P, R> ProtoType<R> for P
where R: RustType,

Source §

fn into_rust(self) -> Result<R, TryFromProtoError>

See RustType::from_proto.

Source §

fn from_rust(rust: &R) -> P

See RustType::into_proto.

Source §

impl<T> Same for T

Source §

type Output = T

Should always be Self

Source §

impl<'a, S, T> Semigroup<&'a S> for T
where T: Semigroup<S>,

Source §

fn plus_equals(&mut self, rhs: &&'a S)

The method of std::ops::AddAssign, for types that do not implement AddAssign.

Source §

impl<T> ServiceExt for T

Source §

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more

Source §

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more

Source §

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more

Source §

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more

Source §

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. 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> ToStringFallible for T
where T: Display,

Source §

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

fn vzip(self) -> V

Source §

impl<T> WithSubscriber for T

Source §

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

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

Source §

impl<T> Data for T
where T: Data + Ord + Debug,

Source §

impl<T> Data for T
where T: Clone + 'static,

Source §

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source §

impl<T> ExchangeData for T
where T: ExchangeData + Ord + Debug,

Source §

Enum BinaryFuncCopy item path

Variants§

AddInt16

AddInt32

AddInt64

AddUInt16

AddUInt32

AddUInt64

AddFloat32

AddFloat64

AddInterval

AddTimestampInterval

AddTimestampTzInterval

AddDateInterval

AddDateTime

AddTimeInterval

AddNumeric

AgeTimestamp

AgeTimestampTz

BitAndInt16

BitAndInt32

BitAndInt64

BitAndUInt16

BitAndUInt32

BitAndUInt64

BitOrInt16

BitOrInt32

BitOrInt64

BitOrUInt16

BitOrUInt32

BitOrUInt64

BitXorInt16

BitXorInt32

BitXorInt64

BitXorUInt16

BitXorUInt32

BitXorUInt64

BitShiftLeftInt16

BitShiftLeftInt32

BitShiftLeftInt64

BitShiftLeftUInt16

BitShiftLeftUInt32

BitShiftLeftUInt64

BitShiftRightInt16

BitShiftRightInt32

BitShiftRightInt64

BitShiftRightUInt16

BitShiftRightUInt32

BitShiftRightUInt64

SubInt16

SubInt32

SubInt64

SubUInt16

SubUInt32

SubUInt64

SubFloat32

SubFloat64

SubInterval

SubTimestamp

SubTimestampTz

SubTimestampInterval

SubTimestampTzInterval

SubDate

SubDateInterval

SubTime

SubTimeInterval

SubNumeric

MulInt16

MulInt32

MulInt64

MulUInt16

MulUInt32

MulUInt64

MulFloat32

MulFloat64

MulNumeric

MulInterval

DivInt16

DivInt32

DivInt64

Enum BinaryFunc