Struct rocket::mtls::oid::asn1_rs::Any

source ·
pub struct Any<'a> {
    pub header: Header<'a>,
    pub data: &'a [u8],
}
Available on crate feature mtls only.
Expand description

The Any object is not strictly an ASN.1 type, but holds a generic description of any object that could be encoded.

It contains a header, and either a reference to or owned data for the object content.

Note: this type is only provided in borrowed version (i.e. it can own the inner data).

Fields§

§header: Header<'a>

The object header

§data: &'a [u8]

The object contents

Implementations§

source§

impl<'a> Any<'a>

source

pub const fn new(header: Header<'a>, data: &'a [u8]) -> Any<'a>

Create a new Any from BER/DER header and content

source

pub const fn from_tag_and_data(tag: Tag, data: &'a [u8]) -> Any<'a>

Create a new Any from a tag, and BER/DER content

source

pub const fn class(&self) -> Class

Return the Class of this object

source

pub fn with_class(self, class: Class) -> Any<'a>

Update the class of the current object

source

pub const fn tag(&self) -> Tag

Return the Tag of this object

source

pub fn with_tag(self, tag: Tag) -> Any<'a>

Update the tag of the current object

source

pub fn as_bytes(&'a self) -> &'a [u8]

Get the bytes representation of the content

source

pub fn parse_ber<T>(&'a self) -> Result<(&'a [u8], T), Err<Error>>
where T: FromBer<'a>,

source

pub fn parse_der<T>(&'a self) -> Result<(&'a [u8], T), Err<Error>>
where T: FromDer<'a>,

source§

impl<'a> Any<'a>

source

pub fn bitstring(self) -> Result<BitString<'a>, Error>

Attempt to convert object to BitString<'a> (ASN.1 type: BIT STRING).

source

pub fn bmpstring(self) -> Result<BmpString<'a>, Error>

Attempt to convert object to BmpString<'a> (ASN.1 type: BmpString).

source

pub fn bool(self) -> Result<bool, Error>

Attempt to convert object to bool (ASN.1 type: BOOLEAN).

source

pub fn boolean(self) -> Result<Boolean, Error>

Attempt to convert object to Boolean (ASN.1 type: BOOLEAN).

source

pub fn embedded_pdv(self) -> Result<EmbeddedPdv<'a>, Error>

Attempt to convert object to EmbeddedPdv<'a> (ASN.1 type: EMBEDDED PDV).

source

pub fn enumerated(self) -> Result<Enumerated, Error>

Attempt to convert object to Enumerated (ASN.1 type: ENUMERATED).

source

pub fn generalizedtime(self) -> Result<GeneralizedTime, Error>

Attempt to convert object to GeneralizedTime (ASN.1 type: GeneralizedTime).

source

pub fn generalstring(self) -> Result<GeneralString<'a>, Error>

Attempt to convert object to GeneralString<'a> (ASN.1 type: GeneralString).

source

pub fn graphicstring(self) -> Result<GraphicString<'a>, Error>

Attempt to convert object to GraphicString<'a> (ASN.1 type: GraphicString).

source

pub fn ia5string(self) -> Result<Ia5String<'a>, Error>

Attempt to convert object to Ia5String<'a> (ASN.1 type: IA5String).

source

pub fn integer(self) -> Result<Integer<'a>, Error>

Attempt to convert object to Integer<'a> (ASN.1 type: INTEGER).

source

pub fn null(self) -> Result<Null, Error>

Attempt to convert object to Null (ASN.1 type: NULL).

source

pub fn numericstring(self) -> Result<NumericString<'a>, Error>

Attempt to convert object to NumericString<'a> (ASN.1 type: NumericString).

source

pub fn objectdescriptor(self) -> Result<ObjectDescriptor<'a>, Error>

Attempt to convert object to ObjectDescriptor<'a> (ASN.1 type: ObjectDescriptor).

source

pub fn octetstring(self) -> Result<OctetString<'a>, Error>

Attempt to convert object to OctetString<'a> (ASN.1 type: OCTET STRING).

source

pub fn oid(self) -> Result<Oid<'a>, Error>

Attempt to convert object to Oid<'a> (ASN.1 type: OBJECT IDENTIFIER).

source

pub fn relative_oid(self) -> Result<Oid<'a>, Error>

Attempt to convert object to Oid (ASN.1 type: RELATIVE-OID).

source

pub fn printablestring(self) -> Result<PrintableString<'a>, Error>

Attempt to convert object to PrintableString<'a> (ASN.1 type: PrintableString).

source

pub fn sequence(self) -> Result<Sequence<'a>, Error>

Attempt to convert object to Sequence<'a> (ASN.1 type: SEQUENCE).

source

pub fn set(self) -> Result<Set<'a>, Error>

Attempt to convert object to Set<'a> (ASN.1 type: SET).

source

pub fn string(self) -> Result<String, Error>

Attempt to convert object to String (ASN.1 type: UTF8String).

source

pub fn teletexstring(self) -> Result<TeletexString<'a>, Error>

Attempt to convert object to TeletexString<'a> (ASN.1 type: TeletexString).

source

pub fn u8(self) -> Result<u8, Error>

Attempt to convert object to u8 (ASN.1 type: INTEGER).

source

pub fn u16(self) -> Result<u16, Error>

Attempt to convert object to u16 (ASN.1 type: INTEGER).

source

pub fn u32(self) -> Result<u32, Error>

Attempt to convert object to u32 (ASN.1 type: INTEGER).

source

pub fn u64(self) -> Result<u64, Error>

Attempt to convert object to u64 (ASN.1 type: INTEGER).

source

pub fn universalstring(self) -> Result<UniversalString<'a>, Error>

Attempt to convert object to UniversalString<'a> (ASN.1 type: UniversalString).

source

pub fn utctime(self) -> Result<UtcTime, Error>

Attempt to convert object to UtcTime (ASN.1 type: UTCTime).

source

pub fn utf8string(self) -> Result<Utf8String<'a>, Error>

Attempt to convert object to Utf8String<'a> (ASN.1 type: UTF8String).

source

pub fn videotexstring(self) -> Result<VideotexString<'a>, Error>

Attempt to convert object to VideotexString<'a> (ASN.1 type: VideotexString).

source

pub fn visiblestring(self) -> Result<VisibleString<'a>, Error>

Attempt to convert object to VisibleString<'a> (ASN.1 type: VisibleString).

Trait Implementations§

source§

impl CheckDerConstraints for Any<'_>

source§

impl<'a> Clone for Any<'a>

source§

fn clone(&self) -> Any<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for Any<'a>

source§

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

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

impl DynTagged for Any<'_>

source§

fn tag(&self) -> Tag

source§

impl<'a> FromBer<'a> for Any<'a>

source§

fn from_ber(bytes: &'a [u8]) -> Result<(&'a [u8], Any<'a>), Err<Error>>

Attempt to parse input bytes into a BER object
source§

impl<'a> FromDer<'a> for Any<'a>

source§

fn from_der(bytes: &'a [u8]) -> Result<(&'a [u8], Any<'a>), Err<Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> PartialEq for Any<'a>

source§

fn eq(&self, other: &Any<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl ToDer for Any<'_>

source§

fn write_der_raw(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Similar to using to_der, but uses header without computing length value

source§

fn to_der_len(&self) -> Result<usize, Error>

Get the length of the object, when encoded
source§

fn write_der_header( &self, writer: &mut dyn Write ) -> Result<usize, SerializeError>

Attempt to write the DER header to this writer.
source§

fn write_der_content( &self, writer: &mut dyn Write ) -> Result<usize, SerializeError>

Attempt to write the DER content (all except header) to this writer.
source§

fn to_der_vec(&self) -> Result<Vec<u8>, SerializeError>

Write the DER encoded representation to a newly allocated Vec<u8>.
source§

fn to_der_vec_raw(&self) -> Result<Vec<u8>, SerializeError>

Similar to using to_vec, but uses provided values without changes. This can generate an invalid encoding for a DER object.
source§

fn write_der(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Attempt to write the DER encoded representation (header and content) into this writer. Read more
source§

impl<'a> TryFrom<Any<'a>> for &'a [u8]

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<&'a [u8], Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for &'a str

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<&'a str, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for ()

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<(), Error>

Performs the conversion.
source§

impl<'a, T> TryFrom<Any<'a>> for BTreeSet<T>
where T: FromBer<'a> + Ord,

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<BTreeSet<T>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for BitString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<BitString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for BmpString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<BmpString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Boolean

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Boolean, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for EmbeddedPdv<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<EmbeddedPdv<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for EndOfContent

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<EndOfContent, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Enumerated

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Enumerated, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for GeneralString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<GeneralString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for GeneralizedTime

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<GeneralizedTime, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for GraphicString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<GraphicString<'a>, Error>

Performs the conversion.
source§

impl<'a, T> TryFrom<Any<'a>> for HashSet<T>
where T: FromBer<'a> + Hash + Eq,

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<HashSet<T>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Ia5String<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Ia5String<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Integer<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Integer<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Null

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Null, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for NumericString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<NumericString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for ObjectDescriptor<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<ObjectDescriptor<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for OctetString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<OctetString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Oid<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Oid<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for PrintableString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<PrintableString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Real

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Real, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Sequence<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Sequence<'a>, Error>

Performs the conversion.
source§

impl<'a, T> TryFrom<Any<'a>> for SequenceOf<T>
where T: FromBer<'a>,

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<SequenceOf<T>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Set<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Set<'a>, Error>

Performs the conversion.
source§

impl<'a, T> TryFrom<Any<'a>> for SetOf<T>
where T: FromBer<'a>,

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<SetOf<T>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for String

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<String, Error>

Performs the conversion.
source§

impl<'a, T, const CLASS: u8, const TAG: u32> TryFrom<Any<'a>> for TaggedValue<T, Explicit, CLASS, TAG>
where T: FromBer<'a>,

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<TaggedValue<T, Explicit, CLASS, TAG>, Error>

Performs the conversion.
source§

impl<'a, T, const CLASS: u8, const TAG: u32> TryFrom<Any<'a>> for TaggedValue<T, Implicit, CLASS, TAG>
where T: TryFrom<Any<'a>, Error = Error> + Tagged,

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<TaggedValue<T, Implicit, CLASS, TAG>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for TeletexString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<TeletexString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for UniversalString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<UniversalString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for UtcTime

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<UtcTime, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for Utf8String<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<Utf8String<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for VideotexString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<VideotexString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for VisibleString<'a>

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<VisibleString<'a>, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for bool

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<bool, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for f32

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<f32, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for f64

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<f64, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for i128

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<i128, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for i16

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<i16, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for i32

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<i32, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for i64

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<i64, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for i8

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<i8, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for u128

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<u128, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for u16

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<u16, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for u32

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<u32, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for u64

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<u64, Error>

Performs the conversion.
source§

impl<'a> TryFrom<Any<'a>> for u8

§

type Error = Error

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

fn try_from(any: Any<'a>) -> Result<u8, Error>

Performs the conversion.
source§

impl<'a> StructuralPartialEq for Any<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Any<'a>

§

impl<'a> Send for Any<'a>

§

impl<'a> Sync for Any<'a>

§

impl<'a> Unpin for Any<'a>

§

impl<'a> UnwindSafe for Any<'a>

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<'a, T> AsTaggedExplicit<'a> for T
where T: 'a,

source§

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

source§

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

source§

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

source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

source§

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

source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
source§

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

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

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

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

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

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

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
source§

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

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

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

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

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

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

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
source§

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

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

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

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

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

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

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

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

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

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

Returns self with the attr() set to Attribute::Underline.

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

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

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

Returns self with the attr() set to Attribute::RapidBlink.

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

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

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

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

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

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

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

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

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

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

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
source§

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

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

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

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

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

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

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

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

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

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

Returns self with the quirk() set to Quirk::Clear.

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

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

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

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

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

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

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

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
source§

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

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

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

§

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

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

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

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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