Enum apple_codesign::AppleCodesignError

source · 
pub enum AppleCodesignError {

Show 123 variants    CliUnknownCommand,
    CliBadArgument,
    CliGeneralError(String),
    Io(Error),
    CliDialoguer(Error),
    Goblin(Error),
    InvalidBinary(String),
    InvalidMachOIndex(usize),
    BinaryNoCodeSignature,
    BinaryNoCodeDirectory,
    X509(X509CertificateError),
    Cms(CmsError),
    SerdeJson(Error),
    SerdeYaml(Error),
    GlobPattern(PatternError),
    VerificationProblems,
    CertificateGeneric(String),
    CertificateDecode(DecodeError<Infallible>),
    CertificatePem(PemError),
    X509Parse(String),
    CertificateUnsupportedKeyAlgorithm(KeyAlgorithm),
    CertificateRing(Unspecified),
    CertificateCharset(CharSetError),
    Der(Error),
    VersionParse(Error),
    Xar(Error),
    FlatPackage(Error),
    MissingText,
    MissingLinkedit,
    BadMagic(&'static str),
    Scroll(Error),
    PlistParseXml(Error),
    PlistSerializeXml(Error),
    CodeDirectoryMalformedIdentifier,
    CodeDirectoryMalformedTeam,
    CodeDirectoryPlist(Error),
    SuperblobMalformed,
    UnrecognizedPathType,
    Unimplemented(&'static str),
    CodeSignatureUnknownFlag(String),
    EntitlementsBadUtf8(Utf8Error),
    PlistDer(String),
    ExecutableSegmentUnknownFlag(String),
    RequirementUnknownOpcode(u32),
    RequirementUnknownMatchExpression(u32),
    RequirementMalformed(&'static str),
    ResourcesPlist(Error),
    ResourcesBase64(DecodeError),
    ResourcesPlistParse(String),
    ResourcesBadRegex(String, Error),
    LinkeditNotLast,
    DataAfterSignature,
    LoadCommandNoRoom,
    MachOWrite(String),
    NoIdentifier,
    NoSigningCertificate,
    SignatureDataTooLarge,
    SignatureBuilder(&'static str),
    Reqwest(Error),
    DigestUnknownAlgorithm,
    DigestUnsupportedAlgorithm,
    DigestUnspecified,
    PathIdentifier(String),
    DirectoryBundle(Error),
    BundleUnknown(String),
    BundleNoIdentifier(PathBuf),
    BundleNoMainExecutable(PathBuf),
    BundleUnexpectedResourceRuleResult,
    ParseSettingsScope(String),
    PfxBadPassword,
    PfxParseError(String),
    KeychainError(String),
    WindowsStoreError(String),
    CertificateNotFound(String),
    OidIsntCertificateAuthority,
    OidIsntExtendedKeyUsage,
    OidIsntCodeSigningExtension,
    CertificateBuildError(String),
    UnknownCertificateProfile(String),
    UnknownPolicy(String),
    PolicyFormulationError(String),
    UniversalMachO(UniversalMachOError),
    WalkDir(Error),
    ZipError(ZipError),
    AppMetadataXml(Error),
    XmlWrite(Error),
    XarNoAdhoc,
    AppStoreConnectApiKey(String),
    AppStoreConnectApiKeyNotFound,
    ForNotarizationInvalidSettings,
    NotarizeUnsupportedPath(PathBuf),
    NotarizeNoAuthCredentials,
    NotarizeWaitLimitReached,
    NotarizeServerError,
    NotarizeRejected(i64, String),
    NotarizeIncomplete,
    NotarizeInvalid,
    NotarizationRecordNotInResponse(String),
    NotarizationRecordNoSignedTicket,
    NotarizationRecordSignedTicketNotBytes(String),
    NotarizationLookupFailure(String, String),
    NotarizationRecordDecodeFailure(DecodeError),
    BundleUnknownAppPlatform,
    StapleUnsupportedBundleType(BundlePackageType),
    StapleMalformedXar,
    StapleMainExecutableNotFound,
    StapleUnsupportedPath(PathBuf),
    DmgBadMagic,
    DmgNotarizeNoSignature,
    DmgStapleNoSignature,
    SmartcardNoCertificate(String),
    SmartcardFailedAuthentication,
    PoisonedLock,
    LogicError(String),
    ZipStructs(ZipReadError),
    RemoteSign(RemoteSignError),
    AwsByteStream(Error),
    AwsS3Error(Box<Error>),
    BadTime,
    Anyhow(Error),
    Plist(Error),
    Figment(Error),
    EnvironmentConstraint(String),

}
Expand description

Unified error type for Apple code signing.

Variants§

§

CliUnknownCommand

§

CliBadArgument

§

CliGeneralError(String)

§

Io(Error)

§

CliDialoguer(Error)

§

Goblin(Error)

§

InvalidBinary(String)

§

InvalidMachOIndex(usize)

§

BinaryNoCodeSignature

§

BinaryNoCodeDirectory

§

X509(X509CertificateError)

§

Cms(CmsError)

§

SerdeJson(Error)

§

SerdeYaml(Error)

§

GlobPattern(PatternError)

§

VerificationProblems

§

CertificateGeneric(String)

§

CertificateDecode(DecodeError<Infallible>)

§

CertificatePem(PemError)

§

X509Parse(String)

§

CertificateUnsupportedKeyAlgorithm(KeyAlgorithm)

§

CertificateRing(Unspecified)

§

CertificateCharset(CharSetError)

§

Der(Error)

§

VersionParse(Error)

§

Xar(Error)

§

FlatPackage(Error)

§

MissingText

§

MissingLinkedit

§

BadMagic(&'static str)

§

Scroll(Error)

§

PlistParseXml(Error)

§

PlistSerializeXml(Error)

§

CodeDirectoryMalformedIdentifier

§

CodeDirectoryMalformedTeam

§

CodeDirectoryPlist(Error)

§

SuperblobMalformed

§

UnrecognizedPathType

§

Unimplemented(&'static str)

§

CodeSignatureUnknownFlag(String)

§

EntitlementsBadUtf8(Utf8Error)

§

PlistDer(String)

§

ExecutableSegmentUnknownFlag(String)

§

RequirementUnknownOpcode(u32)

§

RequirementUnknownMatchExpression(u32)

§

RequirementMalformed(&'static str)

§

ResourcesPlist(Error)

§

ResourcesBase64(DecodeError)

§

ResourcesPlistParse(String)

§

ResourcesBadRegex(String, Error)

§

LinkeditNotLast

§

DataAfterSignature

§

LoadCommandNoRoom

§

MachOWrite(String)

§

NoIdentifier

§

NoSigningCertificate

§

SignatureDataTooLarge

§

SignatureBuilder(&'static str)

§

Reqwest(Error)

§

DigestUnknownAlgorithm

§

DigestUnsupportedAlgorithm

§

DigestUnspecified

§

PathIdentifier(String)

§

DirectoryBundle(Error)

§

BundleUnknown(String)

§

BundleNoIdentifier(PathBuf)

§

BundleNoMainExecutable(PathBuf)

§

BundleUnexpectedResourceRuleResult

§

ParseSettingsScope(String)

§

PfxBadPassword

§

PfxParseError(String)

§

KeychainError(String)

§

WindowsStoreError(String)

§

CertificateNotFound(String)

§

OidIsntCertificateAuthority

§

OidIsntExtendedKeyUsage

§

OidIsntCodeSigningExtension

§

CertificateBuildError(String)

§

UnknownCertificateProfile(String)

§

UnknownPolicy(String)

§

PolicyFormulationError(String)

§

UniversalMachO(UniversalMachOError)

§

WalkDir(Error)

§

ZipError(ZipError)

§

AppMetadataXml(Error)

§

XmlWrite(Error)

§

XarNoAdhoc

§

AppStoreConnectApiKey(String)

§

AppStoreConnectApiKeyNotFound

§

ForNotarizationInvalidSettings

§

NotarizeUnsupportedPath(PathBuf)

§

NotarizeNoAuthCredentials

§

NotarizeWaitLimitReached

§

NotarizeServerError

§

NotarizeRejected(i64, String)

§

NotarizeIncomplete

§

NotarizeInvalid

§

NotarizationRecordNotInResponse(String)

§

NotarizationRecordNoSignedTicket

§

NotarizationRecordSignedTicketNotBytes(String)

§

NotarizationLookupFailure(String, String)

§

NotarizationRecordDecodeFailure(DecodeError)

§

BundleUnknownAppPlatform

§

StapleUnsupportedBundleType(BundlePackageType)

§

StapleMalformedXar

§

StapleMainExecutableNotFound

§

StapleUnsupportedPath(PathBuf)

§

DmgBadMagic

§

DmgNotarizeNoSignature

§

DmgStapleNoSignature

§

SmartcardNoCertificate(String)

§

SmartcardFailedAuthentication

§

PoisonedLock

§

LogicError(String)

§

ZipStructs(ZipReadError)

§

RemoteSign(RemoteSignError)

§

AwsByteStream(Error)

§

AwsS3Error(Box<Error>)

§

BadTime

§

Anyhow(Error)

§

Plist(Error)

§

Figment(Error)

§

EnvironmentConstraint(String)

Trait Implementations§

source§

impl Debug for AppleCodesignError

source§

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

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

impl Display for AppleCodesignError

source§

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

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

impl Error for AppleCodesignError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<CmsError> for AppleCodesignError

source§

fn from(source: CmsError) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for AppleCodesignError

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<PatternError> for AppleCodesignError

source§

fn from(source: PatternError) -> Self

Converts to this type from the input type.
source§

impl From<RemoteSignError> for AppleCodesignError

source§

fn from(source: RemoteSignError) -> Self

Converts to this type from the input type.
source§

impl From<X509CertificateError> for AppleCodesignError

source§

fn from(source: X509CertificateError) -> Self

Converts to this type from the input type.
source§

impl From<ZipError> for AppleCodesignError

source§

fn from(source: ZipError) -> Self

Converts to this type from the input type.
source§

impl From<ZipReadError> for AppleCodesignError

source§

fn from(source: ZipReadError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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
§

impl<T> AsErrorSource for T
where T: Error + 'static,

§

fn as_error_source(&self) -> &(dyn Error + 'static)

For maximum effectiveness, this needs to be called as a method to benefit from Rust’s automatic dereferencing of method receivers.
§

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>

source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

type Type = T

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

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

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

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
§

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

§

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

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

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

Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Enables the styling [Attribute] value.

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

Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Enables the yansi [Quirk] value.

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

Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
§

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

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

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

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

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

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

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

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

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

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

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

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

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> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
§

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