miden_test_utils::crypto

Struct RpoDigest

pub struct RpoDigest(/* private fields */);

Implementations§

impl RpoDigest

pub const SERIALIZED_SIZE: usize = 32usize

The serialized size of the digest in bytes.

pub const fn new(value: [BaseElement; 4]) -> RpoDigest

pub fn as_elements(&self) -> &[BaseElement]

pub fn as_bytes(&self) -> [u8; 32]

pub fn digests_as_elements_iter<'a, I>( digests: I, ) -> impl Iterator<Item = &'a BaseElement>
where I: Iterator<Item = &'a RpoDigest>,

pub fn digests_as_elements(digests: &[RpoDigest]) -> &[BaseElement]

pub fn to_hex(&self) -> String

Returns hexadecimal representation of this digest prefixed with 0x.

Trait Implementations§

impl Clone for RpoDigest

fn clone(&self) -> RpoDigest

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

impl Debug for RpoDigest

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

Formats the value using the given formatter. Read more

impl Default for RpoDigest

fn default() -> RpoDigest

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

impl Deref for RpoDigest

type Target = [BaseElement; 4]

The resulting type after dereferencing.

fn deref(&self) -> &<RpoDigest as Deref>::Target

Dereferences the value.

impl Deserializable for RpoDigest

fn read_from<R>(source: &mut R) -> Result<RpoDigest, DeserializationError>
where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result. Read more

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result. Read more

impl Digest for RpoDigest

fn as_bytes(&self) -> [u8; 32]

Returns this digest serialized into an array of bytes. Read more

impl Display for RpoDigest

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

Formats the value using the given formatter. Read more

impl From<&[BaseElement; 4]> for RpoDigest

fn from(value: &[BaseElement; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<&[bool; 4]> for RpoDigest

fn from(value: &[bool; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<&[u16; 4]> for RpoDigest

fn from(value: &[u16; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<&[u32; 4]> for RpoDigest

fn from(value: &[u32; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<&[u8; 4]> for RpoDigest

fn from(value: &[u8; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<&RpoDigest> for [BaseElement; 4]

fn from(value: &RpoDigest) -> [BaseElement; 4]

Converts to this type from the input type.

impl From<&RpoDigest> for [u64; 4]

fn from(value: &RpoDigest) -> [u64; 4]

Converts to this type from the input type.

impl From<&RpoDigest> for [u8; 32]

fn from(value: &RpoDigest) -> [u8; 32]

Converts to this type from the input type.

impl From<&RpoDigest> for LeafIndex<miden_crypto::::merkle::smt::full::{impl#5}::{constant#0}>

fn from( value: &RpoDigest, ) -> LeafIndex<miden_crypto::::merkle::smt::full::{impl#5}::{constant#0}>

Converts to this type from the input type.

impl From<[BaseElement; 4]> for RpoDigest

fn from(value: [BaseElement; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<[bool; 4]> for RpoDigest

fn from(value: [bool; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<[u16; 4]> for RpoDigest

fn from(value: [u16; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<[u32; 4]> for RpoDigest

fn from(value: [u32; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<[u8; 4]> for RpoDigest

fn from(value: [u8; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<RpoDigest> for [BaseElement; 4]

fn from(value: RpoDigest) -> [BaseElement; 4]

Converts to this type from the input type.

impl From<RpoDigest> for [u64; 4]

fn from(value: RpoDigest) -> [u64; 4]

Converts to this type from the input type.

impl From<RpoDigest> for [u8; 32]

fn from(value: RpoDigest) -> [u8; 32]

Converts to this type from the input type.

impl From<RpoDigest> for LeafIndex<miden_crypto::::merkle::smt::full::{impl#4}::{constant#0}>

fn from( value: RpoDigest, ) -> LeafIndex<miden_crypto::::merkle::smt::full::{impl#4}::{constant#0}>

Converts to this type from the input type.

impl FromIterator<RpoDigest> for MerklePath

fn from_iter<T>(iter: T) -> MerklePath
where T: IntoIterator<Item = RpoDigest>,

Creates a value from an iterator. Read more

impl Hash for RpoDigest

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

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

impl IntoIterator for RpoDigest

type Item = BaseElement

The type of the elements being iterated over.

type IntoIter = <[BaseElement; 4] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <RpoDigest as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl KvMap<RpoDigest, Vec<BaseElement>> for AdviceMap

fn get(&self, key: &RpoDigest) -> Option<&Vec<BaseElement>>

fn contains_key(&self, key: &RpoDigest) -> bool

fn len(&self) -> usize

fn insert( &mut self, key: RpoDigest, value: Vec<BaseElement>, ) -> Option<Vec<BaseElement>>

fn remove(&mut self, key: &RpoDigest) -> Option<Vec<BaseElement>>

fn iter(&self) -> Box<dyn Iterator<Item = (&RpoDigest, &Vec<BaseElement>)> + '_>

fn is_empty(&self) -> bool

impl Ord for RpoDigest

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

impl PartialEq for RpoDigest

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

impl PartialOrd for RpoDigest

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

impl Randomizable for RpoDigest

const VALUE_SIZE: usize = 32usize

Size of Self in bytes. Read more

fn from_random_bytes(bytes: &[u8]) -> Option<RpoDigest>

Returns Self if the set of bytes forms a valid value, otherwise returns None.

impl Serializable for RpoDigest

fn write_into<W>(&self, target: &mut W)
where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self. Read more

fn to_bytes(&self) -> Vec<u8> ⓘ

Serializes self into a vector of bytes.

impl TryFrom<&[u64; 4]> for RpoDigest

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from(value: &[u64; 4]) -> Result<RpoDigest, RpoDigestError>

Performs the conversion.

impl TryFrom<&[u8]> for RpoDigest

type Error = HexParseError

The type returned in the event of a conversion error.

fn try_from( value: &[u8], ) -> Result<RpoDigest, <RpoDigest as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&[u8; 32]> for RpoDigest

type Error = HexParseError

The type returned in the event of a conversion error.

fn try_from( value: &[u8; 32], ) -> Result<RpoDigest, <RpoDigest as TryFrom<&[u8; 32]>>::Error>

Performs the conversion.

impl TryFrom<&RpoDigest> for [bool; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: &RpoDigest, ) -> Result<[bool; 4], <[bool; 4] as TryFrom<&RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<&RpoDigest> for [u16; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: &RpoDigest, ) -> Result<[u16; 4], <[u16; 4] as TryFrom<&RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<&RpoDigest> for [u32; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: &RpoDigest, ) -> Result<[u32; 4], <[u32; 4] as TryFrom<&RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<&RpoDigest> for [u8; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: &RpoDigest, ) -> Result<[u8; 4], <[u8; 4] as TryFrom<&RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<&String> for RpoDigest

fn try_from( value: &String, ) -> Result<RpoDigest, <RpoDigest as TryFrom<&String>>::Error>

Expects the string to start with 0x.

type Error = HexParseError

The type returned in the event of a conversion error.

impl TryFrom<&str> for RpoDigest

fn try_from( value: &str, ) -> Result<RpoDigest, <RpoDigest as TryFrom<&str>>::Error>

Expects the string to start with 0x.

type Error = HexParseError

The type returned in the event of a conversion error.

impl TryFrom<[u64; 4]> for RpoDigest

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from(value: [u64; 4]) -> Result<RpoDigest, RpoDigestError>

Performs the conversion.

impl TryFrom<[u8; 32]> for RpoDigest

type Error = HexParseError

The type returned in the event of a conversion error.

fn try_from( value: [u8; 32], ) -> Result<RpoDigest, <RpoDigest as TryFrom<[u8; 32]>>::Error>

Performs the conversion.

impl TryFrom<RpoDigest> for [bool; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: RpoDigest, ) -> Result<[bool; 4], <[bool; 4] as TryFrom<RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<RpoDigest> for [u16; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: RpoDigest, ) -> Result<[u16; 4], <[u16; 4] as TryFrom<RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<RpoDigest> for [u32; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: RpoDigest, ) -> Result<[u32; 4], <[u32; 4] as TryFrom<RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<RpoDigest> for [u8; 4]

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from( value: RpoDigest, ) -> Result<[u8; 4], <[u8; 4] as TryFrom<RpoDigest>>::Error>

Performs the conversion.

impl TryFrom<String> for RpoDigest

fn try_from( value: String, ) -> Result<RpoDigest, <RpoDigest as TryFrom<String>>::Error>

Expects the string to start with 0x.

type Error = HexParseError

The type returned in the event of a conversion error.

impl Copy for RpoDigest

impl Eq for RpoDigest

impl StructuralPartialEq for RpoDigest

Auto Trait Implementations§

impl Freeze for RpoDigest

impl RefUnwindSafe for RpoDigest

impl Send for RpoDigest

impl Sync for RpoDigest

impl Unpin for RpoDigest

impl UnwindSafe for RpoDigest

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

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

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

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

§Example

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

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

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> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

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