Struct Flags AndTimestamp &nbsp; Copy item path

impl FlagsAndTimestamp

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl FlagsAndTimestamp

pub const fn into_bytes(self) -> [u8; 8]

Returns the underlying bits.

§Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 8]) -> Self

Converts the given bytes directly into the bitfield struct.

impl FlagsAndTimestamp

pub fn block_type(&self) -> <BlockType as Specifier>::InOut

Returns the value of block_type.

pub fn block_type_or_err( &self, ) -> Result<<BlockType as Specifier>::InOut, InvalidBitPattern<<BlockType as Specifier>::Bytes>>

Returns the value of block_type.

§Errors

If the returned value contains an invalid bit pattern for block_type.

pub fn with_block_type(self, new_val: <BlockType as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of block_type set to the given value.

§Panics

If the given value is out of bounds for block_type.

pub fn with_block_type_checked( self, new_val: <BlockType as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of block_type set to the given value.

§Errors

If the given value is out of bounds for block_type.

pub fn set_block_type(&mut self, new_val: <BlockType as Specifier>::InOut)

Sets the value of block_type to the given value.

§Panics

If the given value is out of bounds for block_type.

pub fn set_block_type_checked( &mut self, new_val: <BlockType as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of block_type to the given value.

§Errors

If the given value is out of bounds for block_type.

pub fn has_side_effects(&self) -> <bool as Specifier>::InOut

Returns the value of has_side_effects.

pub fn has_side_effects_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of has_side_effects.

§Errors

If the returned value contains an invalid bit pattern for has_side_effects.

pub fn with_has_side_effects(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of has_side_effects set to the given value.

§Panics

If the given value is out of bounds for has_side_effects.

pub fn with_has_side_effects_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of has_side_effects set to the given value.

§Errors

If the given value is out of bounds for has_side_effects.

pub fn set_has_side_effects(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of has_side_effects to the given value.

§Panics

If the given value is out of bounds for has_side_effects.

pub fn set_has_side_effects_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of has_side_effects to the given value.

§Errors

If the given value is out of bounds for has_side_effects.

pub fn has_only_data(&self) -> <bool as Specifier>::InOut

Returns the value of has_only_data.

pub fn has_only_data_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of has_only_data.

§Errors

If the returned value contains an invalid bit pattern for has_only_data.

pub fn with_has_only_data(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of has_only_data set to the given value.

§Panics

If the given value is out of bounds for has_only_data.

pub fn with_has_only_data_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of has_only_data set to the given value.

§Errors

If the given value is out of bounds for has_only_data.

pub fn set_has_only_data(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of has_only_data to the given value.

§Panics

If the given value is out of bounds for has_only_data.

pub fn set_has_only_data_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of has_only_data to the given value.

§Errors

If the given value is out of bounds for has_only_data.

pub fn is_end_of_section(&self) -> <bool as Specifier>::InOut

Returns the value of is_end_of_section.

pub fn is_end_of_section_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of is_end_of_section.

§Errors

If the returned value contains an invalid bit pattern for is_end_of_section.

pub fn with_is_end_of_section(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of is_end_of_section set to the given value.

§Panics

If the given value is out of bounds for is_end_of_section.

pub fn with_is_end_of_section_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of is_end_of_section set to the given value.

§Errors

If the given value is out of bounds for is_end_of_section.

pub fn set_is_end_of_section(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of is_end_of_section to the given value.

§Panics

If the given value is out of bounds for is_end_of_section.

pub fn set_is_end_of_section_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of is_end_of_section to the given value.

§Errors

If the given value is out of bounds for is_end_of_section.

pub fn is_end_of_context(&self) -> <bool as Specifier>::InOut

Returns the value of is_end_of_context.

pub fn is_end_of_context_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of is_end_of_context.

§Errors

If the returned value contains an invalid bit pattern for is_end_of_context.

pub fn with_is_end_of_context(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of is_end_of_context set to the given value.

§Panics

If the given value is out of bounds for is_end_of_context.

pub fn with_is_end_of_context_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of is_end_of_context set to the given value.

§Errors

If the given value is out of bounds for is_end_of_context.

pub fn set_is_end_of_context(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of is_end_of_context to the given value.

§Panics

If the given value is out of bounds for is_end_of_context.

pub fn set_is_end_of_context_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of is_end_of_context to the given value.

§Errors

If the given value is out of bounds for is_end_of_context.

pub fn has_lifetime(&self) -> <bool as Specifier>::InOut

Returns the value of has_lifetime.

pub fn has_lifetime_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of has_lifetime.

§Errors

If the returned value contains an invalid bit pattern for has_lifetime.

pub fn with_has_lifetime(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of has_lifetime set to the given value.

§Panics

If the given value is out of bounds for has_lifetime.

pub fn with_has_lifetime_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of has_lifetime set to the given value.

§Errors

If the given value is out of bounds for has_lifetime.

pub fn set_has_lifetime(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of has_lifetime to the given value.

§Panics

If the given value is out of bounds for has_lifetime.

pub fn set_has_lifetime_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of has_lifetime to the given value.

§Errors

If the given value is out of bounds for has_lifetime.

pub fn has_represented_by(&self) -> <bool as Specifier>::InOut

Returns the value of has_represented_by.

pub fn has_represented_by_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of has_represented_by.

§Errors

If the returned value contains an invalid bit pattern for has_represented_by.

pub fn with_has_represented_by( self, new_val: <bool as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of has_represented_by set to the given value.

§Panics

If the given value is out of bounds for has_represented_by.

pub fn with_has_represented_by_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of has_represented_by set to the given value.

§Errors

If the given value is out of bounds for has_represented_by.

pub fn set_has_represented_by(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of has_represented_by to the given value.

§Panics

If the given value is out of bounds for has_represented_by.

pub fn set_has_represented_by_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of has_represented_by to the given value.

§Errors

If the given value is out of bounds for has_represented_by.

pub fn has_iv(&self) -> <bool as Specifier>::InOut

Returns the value of has_iv.

pub fn has_iv_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of has_iv.

§Errors

If the returned value contains an invalid bit pattern for has_iv.

pub fn with_has_iv(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of has_iv set to the given value.

§Panics

If the given value is out of bounds for has_iv.

pub fn with_has_iv_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of has_iv set to the given value.

§Errors

If the given value is out of bounds for has_iv.

pub fn set_has_iv(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of has_iv to the given value.

§Panics

If the given value is out of bounds for has_iv.

pub fn set_has_iv_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of has_iv to the given value.

§Errors

If the given value is out of bounds for has_iv.

pub fn is_compressed(&self) -> <bool as Specifier>::InOut

Returns the value of is_compressed.

pub fn is_compressed_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of is_compressed.

§Errors

If the returned value contains an invalid bit pattern for is_compressed.

pub fn with_is_compressed(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of is_compressed set to the given value.

§Panics

If the given value is out of bounds for is_compressed.

pub fn with_is_compressed_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of is_compressed set to the given value.

§Errors

If the given value is out of bounds for is_compressed.

pub fn set_is_compressed(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of is_compressed to the given value.

§Panics

If the given value is out of bounds for is_compressed.

pub fn set_is_compressed_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of is_compressed to the given value.

§Errors

If the given value is out of bounds for is_compressed.

pub fn is_signature_in_last_subblock(&self) -> <bool as Specifier>::InOut

Returns the value of is_signature_in_last_subblock.

pub fn is_signature_in_last_subblock_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of is_signature_in_last_subblock.

§Errors

If the returned value contains an invalid bit pattern for is_signature_in_last_subblock.

pub fn with_is_signature_in_last_subblock( self, new_val: <bool as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of is_signature_in_last_subblock set to the given value.

§Panics

If the given value is out of bounds for is_signature_in_last_subblock.

pub fn with_is_signature_in_last_subblock_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of is_signature_in_last_subblock set to the given value.

§Errors

If the given value is out of bounds for is_signature_in_last_subblock.

pub fn set_is_signature_in_last_subblock( &mut self, new_val: <bool as Specifier>::InOut, )

Sets the value of is_signature_in_last_subblock to the given value.

§Panics

If the given value is out of bounds for is_signature_in_last_subblock.

pub fn set_is_signature_in_last_subblock_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of is_signature_in_last_subblock to the given value.

§Errors

If the given value is out of bounds for is_signature_in_last_subblock.

pub fn creation_timestamp(&self) -> <B43 as Specifier>::InOut

Returns the value of creation_timestamp.

pub fn creation_timestamp_or_err( &self, ) -> Result<<B43 as Specifier>::InOut, InvalidBitPattern<<B43 as Specifier>::Bytes>>

Returns the value of creation_timestamp.

§Errors

If the returned value contains an invalid bit pattern for creation_timestamp.

pub fn with_creation_timestamp(self, new_val: <B43 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of creation_timestamp set to the given value.

§Panics

If the given value is out of bounds for creation_timestamp.

pub fn with_creation_timestamp_checked( self, new_val: <B43 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of creation_timestamp set to the given value.

§Errors

If the given value is out of bounds for creation_timestamp.

pub fn set_creation_timestamp(&mut self, new_val: <B43 as Specifier>::InOut)

Sets the value of creation_timestamp to the given value.

§Panics

If the given value is out of bounds for creation_timestamp.

pub fn set_creation_timestamp_checked( &mut self, new_val: <B43 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of creation_timestamp to the given value.

§Errors

If the given value is out of bounds for creation_timestamp.

Trait Implementations§

impl BinRead for FlagsAndTimestamp

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options(). Read more

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments. Read more

fn read<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments. Read more

fn read_be<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order. Read more

fn read_le<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order. Read more

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order. Read more

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments. Read more

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments. Read more

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments. Read more

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments. Read more

impl BinWrite for FlagsAndTimestamp

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options(). Read more

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments. Read more

fn write<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments. Read more

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order. Read more

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order. Read more

fn write_ne<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order. Read more

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments. Read more

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments. Read more

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments. Read more

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments. Read more

fn clone(&self) -> FlagsAndTimestamp

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 FlagsAndTimestamp

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

Formats the value using the given formatter. Read more

impl Default for FlagsAndTimestamp

fn default() -> Self

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

impl PartialEq for FlagsAndTimestamp

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

const ENDIAN: EndianKind

The endianness of the type.

impl WriteEndian for FlagsAndTimestamp

const ENDIAN: EndianKind

The endianness of the type.

impl Copy for FlagsAndTimestamp

impl StructuralPartialEq for FlagsAndTimestamp

Auto Trait Implementations§

impl Freeze for FlagsAndTimestamp

impl RefUnwindSafe for FlagsAndTimestamp

impl Send for FlagsAndTimestamp

impl Sync for FlagsAndTimestamp

impl Unpin for FlagsAndTimestamp

impl UnwindSafe for FlagsAndTimestamp

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> Any for T
where T: Any,

fn get_type_id(&self) -> TypeId

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

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

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

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

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

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

type Output = T

Should always be Self

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::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

impl<T> ErasedDestructor for T
where T: 'static,

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,