Skip to main content

DMat2

Struct DMat2 

Source
#[repr(C)]
pub struct DMat2 { pub x_axis: DVec2, pub y_axis: DVec2, }
Expand description

A 2x2 column major matrix.

Fields§

§x_axis: DVec2§y_axis: DVec2

Implementations§

Source§

impl DMat2

Source

pub const ZERO: DMat2

A 2x2 matrix with all elements set to 0.0.

Source

pub const IDENTITY: DMat2

A 2x2 identity matrix, where all diagonal elements are 1, and all off-diagonal elements are 0.

Source

pub const NAN: DMat2

All NAN:s.

Source

pub const fn from_cols(x_axis: DVec2, y_axis: DVec2) -> DMat2

Creates a 2x2 matrix from two column vectors.

Source

pub const fn from_cols_array(m: &[f64; 4]) -> DMat2

Creates a 2x2 matrix from a [f64; 4] array stored in column major order. If your data is stored in row major you will need to transpose the returned matrix.

Source

pub const fn to_cols_array(&self) -> [f64; 4]

Creates a [f64; 4] array storing data in column major order. If you require data in row major order transpose the matrix first.

Source

pub const fn from_cols_array_2d(m: &[[f64; 2]; 2]) -> DMat2

Creates a 2x2 matrix from a [[f64; 2]; 2] 2D array stored in column major order. If your data is in row major order you will need to transpose the returned matrix.

Source

pub const fn to_cols_array_2d(&self) -> [[f64; 2]; 2]

Creates a [[f64; 2]; 2] 2D array storing data in column major order. If you require data in row major order transpose the matrix first.

Source

pub const fn from_diagonal(diagonal: DVec2) -> DMat2

Creates a 2x2 matrix with its diagonal set to diagonal and all other entries set to 0.

Source

pub fn from_scale_angle(scale: DVec2, angle: f64) -> DMat2

Creates a 2x2 matrix containing the combining non-uniform scale and rotation of angle (in radians).

Source

pub fn from_angle(angle: f64) -> DMat2

Creates a 2x2 matrix containing a rotation of angle (in radians).

Source

pub fn from_mat3(m: DMat3) -> DMat2

Creates a 2x2 matrix from a 3x3 matrix, discarding the 2nd row and column.

Source

pub fn from_mat3_minor(m: DMat3, i: usize, j: usize) -> DMat2

Creates a 2x2 matrix from the minor of the given 3x3 matrix, discarding the ith column and jth row.

§Panics

Panics if i or j is greater than 2.

Source

pub const fn from_cols_slice(slice: &[f64]) -> DMat2

Creates a 2x2 matrix from the first 4 values in slice.

§Panics

Panics if slice is less than 4 elements long.

Source

pub fn write_cols_to_slice(&self, slice: &mut [f64])

Writes the columns of self to the first 4 elements in slice.

§Panics

Panics if slice is less than 4 elements long.

Source

pub fn col(&self, index: usize) -> DVec2

Returns the matrix column for the given index.

§Panics

Panics if index is greater than 1.

Source

pub fn col_mut(&mut self, index: usize) -> &mut DVec2

Returns a mutable reference to the matrix column for the given index.

§Panics

Panics if index is greater than 1.

Source

pub fn row(&self, index: usize) -> DVec2

Returns the matrix row for the given index.

§Panics

Panics if index is greater than 1.

Source

pub fn is_finite(&self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

Source

pub fn is_nan(&self) -> bool

Returns true if any elements are NaN.

Source

pub fn transpose(&self) -> DMat2

Returns the transpose of self.

Source

pub fn diagonal(&self) -> DVec2

Returns the diagonal of self.

Source

pub fn determinant(&self) -> f64

Returns the determinant of self.

Source

pub fn inverse(&self) -> DMat2

Returns the inverse of self.

If the matrix is not invertible the returned matrix will be invalid.

§Panics

Will panic if the determinant of self is zero when glam_assert is enabled.

Source

pub fn try_inverse(&self) -> Option<DMat2>

Returns the inverse of self or None if the matrix is not invertible.

Source

pub fn inverse_or_zero(&self) -> DMat2

Returns the inverse of self or DMat2::ZERO if the matrix is not invertible.

Source

pub fn mul_vec2(&self, rhs: DVec2) -> DVec2

Transforms a 2D vector.

Source

pub fn mul_transpose_vec2(&self, rhs: DVec2) -> DVec2

Transforms a 2D vector by the transpose of self.

Source

pub fn mul_mat2(&self, rhs: &DMat2) -> DMat2

Multiplies two 2x2 matrices.

Source

pub fn add_mat2(&self, rhs: &DMat2) -> DMat2

Adds two 2x2 matrices.

Source

pub fn sub_mat2(&self, rhs: &DMat2) -> DMat2

Subtracts two 2x2 matrices.

Source

pub fn mul_scalar(&self, rhs: f64) -> DMat2

Multiplies a 2x2 matrix by a scalar.

Source

pub fn mul_diagonal_scale(&self, scale: DVec2) -> DMat2

Multiply self by a scaling vector scale. This is faster than creating a whole diagonal scaling matrix and then multiplying that. This operation is commutative.

Source

pub fn div_scalar(&self, rhs: f64) -> DMat2

Divides a 2x2 matrix by a scalar.

Source

pub fn recip(&self) -> DMat2

Returns a matrix containing the reciprocal 1.0/n of each element of self.

Source

pub fn abs_diff_eq(&self, rhs: DMat2, max_abs_diff: f64) -> bool

Returns true if the absolute difference of all elements between self and rhs is less than or equal to max_abs_diff.

This can be used to compare if two matrices contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

Source

pub fn abs(&self) -> DMat2

Takes the absolute value of each element in self

Source

pub fn as_mat2(&self) -> Mat2

Trait Implementations§

Source§

impl Add<&DMat2> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &DMat2) -> DMat2

Performs the + operation. Read more
Source§

impl Add<&DMat2> for DMat2

Source§

type Output = DMat2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &DMat2) -> DMat2

Performs the + operation. Read more
Source§

impl Add<DMat2> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: DMat2) -> DMat2

Performs the + operation. Read more
Source§

impl Add for DMat2

Source§

type Output = DMat2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: DMat2) -> DMat2

Performs the + operation. Read more
Source§

impl AddAssign<&DMat2> for DMat2

Source§

fn add_assign(&mut self, rhs: &DMat2)

Performs the += operation. Read more
Source§

impl AddAssign for DMat2

Source§

fn add_assign(&mut self, rhs: DMat2)

Performs the += operation. Read more
Source§

impl AsMut<[f64; 4]> for DMat2

Source§

fn as_mut(&mut self) -> &mut [f64; 4]

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

impl AsRef<[f64; 4]> for DMat2

Source§

fn as_ref(&self) -> &[f64; 4]

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

impl Clone for DMat2

Source§

fn clone(&self) -> DMat2

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DMat2

Source§

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

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

impl Default for DMat2

Source§

fn default() -> DMat2

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for DMat2

Deserialize expects a sequence of 4 values.

Source§

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

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

impl Display for DMat2

Source§

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

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

impl Div<&f64> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the / operator.
Source§

fn div(self, rhs: &f64) -> DMat2

Performs the / operation. Read more
Source§

impl Div<&f64> for DMat2

Source§

type Output = DMat2

The resulting type after applying the / operator.
Source§

fn div(self, rhs: &f64) -> DMat2

Performs the / operation. Read more
Source§

impl Div<f64> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the / operator.
Source§

fn div(self, rhs: f64) -> DMat2

Performs the / operation. Read more
Source§

impl Div<f64> for DMat2

Source§

type Output = DMat2

The resulting type after applying the / operator.
Source§

fn div(self, rhs: f64) -> DMat2

Performs the / operation. Read more
Source§

impl DivAssign<&f64> for DMat2

Source§

fn div_assign(&mut self, rhs: &f64)

Performs the /= operation. Read more
Source§

impl DivAssign<f64> for DMat2

Source§

fn div_assign(&mut self, rhs: f64)

Performs the /= operation. Read more
Source§

impl Mul<&DMat2> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &DMat2) -> DMat2

Performs the * operation. Read more
Source§

impl Mul<&DMat2> for DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &DMat2) -> DMat2

Performs the * operation. Read more
Source§

impl Mul<&DVec2> for &DMat2

Source§

type Output = DVec2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &DVec2) -> DVec2

Performs the * operation. Read more
Source§

impl Mul<&DVec2> for DMat2

Source§

type Output = DVec2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &DVec2) -> DVec2

Performs the * operation. Read more
Source§

impl Mul<&f64> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &f64) -> DMat2

Performs the * operation. Read more
Source§

impl Mul<&f64> for DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &f64) -> DMat2

Performs the * operation. Read more
Source§

impl Mul<DMat2> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DMat2) -> DMat2

Performs the * operation. Read more
Source§

impl Mul<DVec2> for &DMat2

Source§

type Output = DVec2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DVec2) -> DVec2

Performs the * operation. Read more
Source§

impl Mul<DVec2> for DMat2

Source§

type Output = DVec2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DVec2) -> <DMat2 as Mul<DVec2>>::Output

Performs the * operation. Read more
Source§

impl Mul<f64> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: f64) -> DMat2

Performs the * operation. Read more
Source§

impl Mul<f64> for DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: f64) -> DMat2

Performs the * operation. Read more
Source§

impl Mul for DMat2

Source§

type Output = DMat2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DMat2) -> DMat2

Performs the * operation. Read more
Source§

impl MulAssign<&DMat2> for DMat2

Source§

fn mul_assign(&mut self, rhs: &DMat2)

Performs the *= operation. Read more
Source§

impl MulAssign<&f64> for DMat2

Source§

fn mul_assign(&mut self, rhs: &f64)

Performs the *= operation. Read more
Source§

impl MulAssign<f64> for DMat2

Source§

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation. Read more
Source§

impl MulAssign for DMat2

Source§

fn mul_assign(&mut self, rhs: DMat2)

Performs the *= operation. Read more
Source§

impl Neg for &DMat2

Source§

type Output = DMat2

The resulting type after applying the - operator.
Source§

fn neg(self) -> DMat2

Performs the unary - operation. Read more
Source§

impl Neg for DMat2

Source§

type Output = DMat2

The resulting type after applying the - operator.
Source§

fn neg(self) -> <DMat2 as Neg>::Output

Performs the unary - operation. Read more
Source§

impl PartialEq for DMat2

Source§

fn eq(&self, rhs: &DMat2) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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<'a> Product<&'a DMat2> for DMat2

Source§

fn product<I>(iter: I) -> DMat2
where I: Iterator<Item = &'a DMat2>,

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl Product for DMat2

Source§

fn product<I>(iter: I) -> DMat2
where I: Iterator<Item = DMat2>,

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl Serialize for DMat2

Serialize as a sequence of 4 values.

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 Sub<&DMat2> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &DMat2) -> DMat2

Performs the - operation. Read more
Source§

impl Sub<&DMat2> for DMat2

Source§

type Output = DMat2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &DMat2) -> DMat2

Performs the - operation. Read more
Source§

impl Sub<DMat2> for &DMat2

Source§

type Output = DMat2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: DMat2) -> DMat2

Performs the - operation. Read more
Source§

impl Sub for DMat2

Source§

type Output = DMat2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: DMat2) -> DMat2

Performs the - operation. Read more
Source§

impl SubAssign<&DMat2> for DMat2

Source§

fn sub_assign(&mut self, rhs: &DMat2)

Performs the -= operation. Read more
Source§

impl SubAssign for DMat2

Source§

fn sub_assign(&mut self, rhs: DMat2)

Performs the -= operation. Read more
Source§

impl<'a> Sum<&'a DMat2> for DMat2

Source§

fn sum<I>(iter: I) -> DMat2
where I: Iterator<Item = &'a DMat2>,

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl Sum for DMat2

Source§

fn sum<I>(iter: I) -> DMat2
where I: Iterator<Item = DMat2>,

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl Zeroable for DMat2

§

fn zeroed() -> Self

Source§

impl Copy for DMat2

Source§

impl Pod for DMat2

Auto Trait Implementations§

§

impl Freeze for DMat2

§

impl RefUnwindSafe for DMat2

§

impl Send for DMat2

§

impl Sync for DMat2

§

impl Unpin for DMat2

§

impl UnsafeUnpin for DMat2

§

impl UnwindSafe for DMat2

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
§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
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
§

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

§

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

Give this value the specified foreground colour.
§

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

Give this value the specified background colour.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

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

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

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<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
§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

§

type Proj<U: 'src> = U

§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

§

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

§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Create a new [Painted] with a default [Style]. Read more
§

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
§

impl<'p, T> Seq<'p, T> for T
where T: Clone,

§

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.
§

type Iter<'a> = Once<&'a T> where T: 'a

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

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.
§

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.
§

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a [MaybeRef].
§

impl<T, S> SpanWrap<S> for T
where S: WrappingSpan<T>,

§

fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned

Invokes [WrappingSpan::make_wrapped] to wrap an AST node in a span.
§

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

§

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

Give this value the specified foreground colour, when color is enabled for stdout.
§

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

Give this value the specified background colour, when color is enabled for stdout.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> AnyBitPattern for T
where T: Pod,

§

impl<T> Attachment for T
where T: OpaqueAttachment + Display + Debug,

Source§

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

§

impl<T> NoUninit for T
where T: Pod,

§

impl<T> OpaqueAttachment for T
where T: Send + Sync + 'static,

§

impl<T> OrderedSeq<'_, T> for T
where T: Clone,