Enum TyKind

Source
pub enum TyKind {
    Ident(Ident),
    Primitive(PrimitiveSet),
    Singleton(Literal),
    Union(Vec<(Option<String>, Ty)>),
    Tuple(Vec<TyTupleField>),
    Array(Box<Ty>),
    Function(Option<TyFunc>),
    Any,
    Difference {
        base: Box<Ty>,
        exclude: Box<Ty>,
    },
    GenericArg((usize, String)),
}

Variants§

§

Ident(Ident)

Identifier that still needs to be resolved.

§

Primitive(PrimitiveSet)

Type of a built-in primitive type

§

Singleton(Literal)

Type that contains only a one value

§

Union(Vec<(Option<String>, Ty)>)

Union of sets (sum)

§

Tuple(Vec<TyTupleField>)

Type of tuples (product)

§

Array(Box<Ty>)

Type of arrays

§

Function(Option<TyFunc>)

Type of functions with defined params and return types.

§

Any

Type of every possible value. Super type of all other types. The breaker of chains. Mother of types.

§

Difference

Type that is the largest subtype of base while not a subtype of exclude.

Fields

§base: Box<Ty>
§exclude: Box<Ty>
§

GenericArg((usize, String))

A generic argument. Contains id of the function call node and generic type param name.

Implementations§

Source§

impl TyKind

Source

pub fn is_ident(&self) -> bool

Returns true if this is a TyKind::Ident, otherwise false

Source

pub fn as_ident_mut(&mut self) -> Option<&mut Ident>

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

Source

pub fn as_ident(&self) -> Option<&Ident>

Optionally returns references to the inner fields if this is a TyKind::Ident, otherwise None

Source

pub fn into_ident(self) -> Result<Ident, TyKind>

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

Source

pub fn is_primitive(&self) -> bool

Returns true if this is a TyKind::Primitive, otherwise false

Source

pub fn as_primitive_mut(&mut self) -> Option<&mut PrimitiveSet>

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

Source

pub fn as_primitive(&self) -> Option<&PrimitiveSet>

Optionally returns references to the inner fields if this is a TyKind::Primitive, otherwise None

Source

pub fn into_primitive(self) -> Result<PrimitiveSet, TyKind>

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

Source

pub fn is_singleton(&self) -> bool

Returns true if this is a TyKind::Singleton, otherwise false

Source

pub fn as_singleton_mut(&mut self) -> Option<&mut Literal>

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

Source

pub fn as_singleton(&self) -> Option<&Literal>

Optionally returns references to the inner fields if this is a TyKind::Singleton, otherwise None

Source

pub fn into_singleton(self) -> Result<Literal, TyKind>

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

Source

pub fn is_union(&self) -> bool

Returns true if this is a TyKind::Union, otherwise false

Source

pub fn as_union_mut(&mut self) -> Option<&mut Vec<(Option<String>, Ty)>>

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

Source

pub fn as_union(&self) -> Option<&Vec<(Option<String>, Ty)>>

Optionally returns references to the inner fields if this is a TyKind::Union, otherwise None

Source

pub fn into_union(self) -> Result<Vec<(Option<String>, Ty)>, TyKind>

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

Source

pub fn is_tuple(&self) -> bool

Returns true if this is a TyKind::Tuple, otherwise false

Source

pub fn as_tuple_mut(&mut self) -> Option<&mut Vec<TyTupleField>>

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

Source

pub fn as_tuple(&self) -> Option<&Vec<TyTupleField>>

Optionally returns references to the inner fields if this is a TyKind::Tuple, otherwise None

Source

pub fn into_tuple(self) -> Result<Vec<TyTupleField>, TyKind>

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

Source

pub fn is_array(&self) -> bool

Returns true if this is a TyKind::Array, otherwise false

Source

pub fn as_array_mut(&mut self) -> Option<&mut Box<Ty>>

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

Source

pub fn as_array(&self) -> Option<&Box<Ty>>

Optionally returns references to the inner fields if this is a TyKind::Array, otherwise None

Source

pub fn into_array(self) -> Result<Box<Ty>, TyKind>

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

Source

pub fn is_function(&self) -> bool

Returns true if this is a TyKind::Function, otherwise false

Source

pub fn as_function_mut(&mut self) -> Option<&mut Option<TyFunc>>

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

Source

pub fn as_function(&self) -> Option<&Option<TyFunc>>

Optionally returns references to the inner fields if this is a TyKind::Function, otherwise None

Source

pub fn into_function(self) -> Result<Option<TyFunc>, TyKind>

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

Source

pub fn is_any(&self) -> bool

Returns true if this is a TyKind::Any, otherwise false

Source

pub fn is_difference(&self) -> bool

Returns true if this is a TyKind::Difference, otherwise false

Source

pub fn as_difference_mut(&mut self) -> Option<(&mut Box<Ty>, &mut Box<Ty>)>

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

Source

pub fn as_difference(&self) -> Option<(&Box<Ty>, &Box<Ty>)>

Optionally returns references to the inner fields if this is a TyKind::Difference, otherwise None

Source

pub fn into_difference(self) -> Result<(Box<Ty>, Box<Ty>), TyKind>

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

Source

pub fn is_generic_arg(&self) -> bool

Returns true if this is a TyKind::GenericArg, otherwise false

Source

pub fn as_generic_arg_mut(&mut self) -> Option<&mut (usize, String)>

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

Source

pub fn as_generic_arg(&self) -> Option<&(usize, String)>

Optionally returns references to the inner fields if this is a TyKind::GenericArg, otherwise None

Source

pub fn into_generic_arg(self) -> Result<(usize, String), TyKind>

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

Trait Implementations§

Source§

impl AsRef<str> for TyKind

Source§

fn as_ref(&self) -> &str

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

impl Clone for TyKind

Source§

fn clone(&self) -> TyKind

Returns a copy 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 TyKind

Source§

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

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

impl<'de> Deserialize<'de> for TyKind

Source§

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

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

impl From<Literal> for TyKind

Source§

fn from(value: Literal) -> TyKind

Converts to this type from the input type.
Source§

impl From<PrimitiveSet> for TyKind

Source§

fn from(value: PrimitiveSet) -> TyKind

Converts to this type from the input type.
Source§

impl From<TyFunc> for TyKind

Source§

fn from(value: TyFunc) -> TyKind

Converts to this type from the input type.
Source§

impl PartialEq for TyKind

Source§

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

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 TyKind

Auto Trait Implementations§

§

impl Freeze for TyKind

§

impl RefUnwindSafe for TyKind

§

impl Send for TyKind

§

impl Sync for TyKind

§

impl Unpin for TyKind

§

impl UnwindSafe for TyKind

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,