Enum TransformKind

Source
pub enum TransformKind {
    Derive {
        assigns: Box<Expr>,
    },
    Select {
        assigns: Box<Expr>,
    },
    Filter {
        filter: Box<Expr>,
    },
    Aggregate {
        assigns: Box<Expr>,
    },
    Sort {
        by: Vec<ColumnSort<Box<Expr>>>,
    },
    Take {
        range: Range<Box<Expr>>,
    },
    Join {
        side: JoinSide,
        with: Box<Expr>,
        filter: Box<Expr>,
    },
    Group {
        by: Box<Expr>,
        pipeline: Box<Expr>,
    },
    Window {
        kind: WindowKind,
        range: Range<Box<Expr>>,
        pipeline: Box<Expr>,
    },
    Append(Box<Expr>),
    Loop(Box<Expr>),
}

Variants§

§

Derive

Fields

§assigns: Box<Expr>
§

Select

Fields

§assigns: Box<Expr>
§

Filter

Fields

§filter: Box<Expr>
§

Aggregate

Fields

§assigns: Box<Expr>
§

Sort

Fields

§

Take

Fields

§range: Range<Box<Expr>>
§

Join

Fields

§with: Box<Expr>
§filter: Box<Expr>
§

Group

Fields

§by: Box<Expr>
§pipeline: Box<Expr>
§

Window

Fields

§range: Range<Box<Expr>>
§pipeline: Box<Expr>
§

Append(Box<Expr>)

§

Loop(Box<Expr>)

Implementations§

Source§

impl TransformKind

Source

pub fn is_derive(&self) -> bool

Returns true if this is a TransformKind::Derive, otherwise false

Source

pub fn as_derive_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Derive, otherwise None

Source

pub fn as_derive(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a TransformKind::Derive, otherwise None

Source

pub fn into_derive(self) -> Result<Box<Expr>, TransformKind>

Returns the inner fields if this is a TransformKind::Derive, otherwise returns back the enum in the Err case of the result

Source

pub fn is_select(&self) -> bool

Returns true if this is a TransformKind::Select, otherwise false

Source

pub fn as_select_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Select, otherwise None

Source

pub fn as_select(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a TransformKind::Select, otherwise None

Source

pub fn into_select(self) -> Result<Box<Expr>, TransformKind>

Returns the inner fields if this is a TransformKind::Select, otherwise returns back the enum in the Err case of the result

Source

pub fn is_filter(&self) -> bool

Returns true if this is a TransformKind::Filter, otherwise false

Source

pub fn as_filter_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Filter, otherwise None

Source

pub fn as_filter(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a TransformKind::Filter, otherwise None

Source

pub fn into_filter(self) -> Result<Box<Expr>, TransformKind>

Returns the inner fields if this is a TransformKind::Filter, otherwise returns back the enum in the Err case of the result

Source

pub fn is_aggregate(&self) -> bool

Returns true if this is a TransformKind::Aggregate, otherwise false

Source

pub fn as_aggregate_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Aggregate, otherwise None

Source

pub fn as_aggregate(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a TransformKind::Aggregate, otherwise None

Source

pub fn into_aggregate(self) -> Result<Box<Expr>, TransformKind>

Returns the inner fields if this is a TransformKind::Aggregate, otherwise returns back the enum in the Err case of the result

Source

pub fn is_sort(&self) -> bool

Returns true if this is a TransformKind::Sort, otherwise false

Source

pub fn as_sort_mut(&mut self) -> Option<&mut Vec<ColumnSort<Box<Expr>>>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Sort, otherwise None

Source

pub fn as_sort(&self) -> Option<&Vec<ColumnSort<Box<Expr>>>>

Optionally returns references to the inner fields if this is a TransformKind::Sort, otherwise None

Source

pub fn into_sort(self) -> Result<Vec<ColumnSort<Box<Expr>>>, TransformKind>

Returns the inner fields if this is a TransformKind::Sort, otherwise returns back the enum in the Err case of the result

Source

pub fn is_take(&self) -> bool

Returns true if this is a TransformKind::Take, otherwise false

Source

pub fn as_take_mut(&mut self) -> Option<&mut Range<Box<Expr>>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Take, otherwise None

Source

pub fn as_take(&self) -> Option<&Range<Box<Expr>>>

Optionally returns references to the inner fields if this is a TransformKind::Take, otherwise None

Source

pub fn into_take(self) -> Result<Range<Box<Expr>>, TransformKind>

Returns the inner fields if this is a TransformKind::Take, otherwise returns back the enum in the Err case of the result

Source

pub fn is_join(&self) -> bool

Returns true if this is a TransformKind::Join, otherwise false

Source

pub fn as_join_mut( &mut self, ) -> Option<(&mut JoinSide, &mut Box<Expr>, &mut Box<Expr>)>

Optionally returns mutable references to the inner fields if this is a TransformKind::Join, otherwise None

Source

pub fn as_join(&self) -> Option<(&JoinSide, &Box<Expr>, &Box<Expr>)>

Optionally returns references to the inner fields if this is a TransformKind::Join, otherwise None

Source

pub fn into_join( self, ) -> Result<(JoinSide, Box<Expr>, Box<Expr>), TransformKind>

Returns the inner fields if this is a TransformKind::Join, otherwise returns back the enum in the Err case of the result

Source

pub fn is_group(&self) -> bool

Returns true if this is a TransformKind::Group, otherwise false

Source

pub fn as_group_mut(&mut self) -> Option<(&mut Box<Expr>, &mut Box<Expr>)>

Optionally returns mutable references to the inner fields if this is a TransformKind::Group, otherwise None

Source

pub fn as_group(&self) -> Option<(&Box<Expr>, &Box<Expr>)>

Optionally returns references to the inner fields if this is a TransformKind::Group, otherwise None

Source

pub fn into_group(self) -> Result<(Box<Expr>, Box<Expr>), TransformKind>

Returns the inner fields if this is a TransformKind::Group, otherwise returns back the enum in the Err case of the result

Source

pub fn is_window(&self) -> bool

Returns true if this is a TransformKind::Window, otherwise false

Source

pub fn as_window_mut( &mut self, ) -> Option<(&mut WindowKind, &mut Range<Box<Expr>>, &mut Box<Expr>)>

Optionally returns mutable references to the inner fields if this is a TransformKind::Window, otherwise None

Source

pub fn as_window(&self) -> Option<(&WindowKind, &Range<Box<Expr>>, &Box<Expr>)>

Optionally returns references to the inner fields if this is a TransformKind::Window, otherwise None

Source

pub fn into_window( self, ) -> Result<(WindowKind, Range<Box<Expr>>, Box<Expr>), TransformKind>

Returns the inner fields if this is a TransformKind::Window, otherwise returns back the enum in the Err case of the result

Source

pub fn is_append(&self) -> bool

Returns true if this is a TransformKind::Append, otherwise false

Source

pub fn as_append_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Append, otherwise None

Source

pub fn as_append(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a TransformKind::Append, otherwise None

Source

pub fn into_append(self) -> Result<Box<Expr>, TransformKind>

Returns the inner fields if this is a TransformKind::Append, otherwise returns back the enum in the Err case of the result

Source

pub fn is_loop(&self) -> bool

Returns true if this is a TransformKind::Loop, otherwise false

Source

pub fn as_loop_mut(&mut self) -> Option<&mut Box<Expr>>

Optionally returns mutable references to the inner fields if this is a TransformKind::Loop, otherwise None

Source

pub fn as_loop(&self) -> Option<&Box<Expr>>

Optionally returns references to the inner fields if this is a TransformKind::Loop, otherwise None

Source

pub fn into_loop(self) -> Result<Box<Expr>, TransformKind>

Returns the inner fields if this is a TransformKind::Loop, otherwise returns back the enum in the Err case of the result

Trait Implementations§

Source§

impl AsRef<str> for TransformKind

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for TransformKind

Source§

fn clone(&self) -> TransformKind

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 TransformKind

Source§

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

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

impl<'de> Deserialize<'de> for TransformKind

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TransformKind, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TransformKind

Source§

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

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TransformKind

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

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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> Container<T> for T
where T: Clone,

Source§

type Iter = Once<T>

An iterator over the items within this container, by value.
Source§

fn get_iter(&self) -> <T as Container<T>>::Iter

Iterate over the elements of the container (using internal iteration because GATs are unstable).
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, 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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