#[non_exhaustive]pub struct GetCodeFindingOutput {Show 50 fields
pub type: FindingType,
pub title: String,
pub severity: FindingSeverityId,
pub summary: Option<String>,
pub detailed_description: Option<String>,
pub category: Option<String>,
pub sub_category: Option<String>,
pub cwe_ids: Option<Vec<String>>,
pub owasp_category: Option<String>,
pub mitigation: Option<String>,
pub file_path: Option<String>,
pub line_number: Option<i32>,
pub cve_id: Option<String>,
pub cvss_base_score: Option<f64>,
pub affected_packages: Option<Vec<AffectedPackage>>,
pub vulnerable_code: Option<String>,
pub relevant_inputs: Option<Vec<String>>,
pub steps_to_reproduce: Option<Vec<String>>,
pub validation: Option<FindingValidation>,
pub end_line: Option<i32>,
pub mitre_techniques: Option<Vec<String>>,
pub remediation_references: Option<Vec<String>>,
pub ocsf_class: Option<FindingOcsfClass>,
pub ocsf_schema_version: Option<String>,
pub product_name: Option<String>,
pub product_vendor_name: Option<String>,
pub product_version: Option<String>,
pub source_status: Option<String>,
pub source_status_id: Option<i32>,
pub first_seen_at: Option<DateTime>,
pub finding_types: Option<Vec<String>>,
pub vulnerabilities: Option<Vec<FindingVulnerability>>,
pub resources: Option<Vec<FindingResource>>,
pub posture: Option<FindingPosture>,
pub finding_id: String,
pub finding_arn: String,
pub environment_id: String,
pub source: String,
pub source_finding_id: String,
pub reported_at: DateTime,
pub status: FindingStatus,
pub status_updated_at: DateTime,
pub created_at: DateTime,
pub scan_run_id: Option<String>,
pub status_message: Option<String>,
pub discard_reason: Option<FindingDiscardReason>,
pub discard_reasoning: Option<String>,
pub duplicate_of_issue_id: Option<String>,
pub created_issue_id: Option<String>,
pub completed_at: Option<DateTime>,
/* private fields */
}Expand description
Contains the current state and details of the requested finding. Which type-specific members are populated depends on type.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.type: FindingTypeWhat kind of finding this is. Determines which of the type-specific members below are populated.
title: StringThe producer’s title for the finding.
severity: FindingSeverityIdThe finding’s severity.
summary: Option<String>A one-paragraph description.
detailed_description: Option<String>The full analysis.
category: Option<String>The producer’s vulnerability category. Not a stable filter key across finding types – see FindingCategory.
sub_category: Option<String>A more specific classification within category.
cwe_ids: Option<Vec<String>>CWE identifiers classifying the finding.
owasp_category: Option<String>The OWASP Top 10 category, when the producer supplies one.
mitigation: Option<String>How to fix the finding.
file_path: Option<String>The file the finding is about.
line_number: Option<i32>The 1-indexed line the finding is about. Bounds are enforced server-side rather than by a constraint trait: a numeric constraint generates a distinct newtype per enclosing structure, so the same concept would not share a type across the create input and the read output.
cve_id: Option<String>The CVE this finding reports, for software-composition findings. Both code types can carry one: a customer document supplies it under vulnerabilities[].cve, and Continuum’s scanner reports CVEs for dependency-manifest findings.
cvss_base_score: Option<f64>The CVSS base score accompanying cveId, when the producer supplies one, from 0.0 to 10.0. Not computed by Continuum. The range is enforced server-side, not by a @range trait – the smithy-rs server SDK does not support range constraints on double shapes (smithy-rs#2007).
affected_packages: Option<Vec<AffectedPackage>>Packages implicated by the finding.
vulnerable_code: Option<String>The vulnerable code fragment.
relevant_inputs: Option<Vec<String>>User-controlled inputs that reach the vulnerability.
steps_to_reproduce: Option<Vec<String>>Steps to reproduce or exploit the finding.
validation: Option<FindingValidation>The validator’s assessment. Absent when no validation ran.
end_line: Option<i32>The last line of the affected range, from the document’s affected_code[].end_line.
mitre_techniques: Option<Vec<String>>MITRE ATT&CK technique identifiers, from the document’s finding_info.attacks[].technique.uid.
remediation_references: Option<Vec<String>>Remediation references, from the document’s vulnerabilities[].remediation.references.
ocsf_class: Option<FindingOcsfClass>The OCSF class the document declared. Determines whether posture is populated.
ocsf_schema_version: Option<String>The OCSF schema version the producer wrote against (metadata.version).
product_name: Option<String>The producing product and vendor (metadata.product).
product_vendor_name: Option<String>A vulnerability-taxonomy label: the producer’s category, sub-category, or OWASP category. Deliberately unconstrained beyond length – producers do not share a taxonomy, so this is NOT a stable filter key across finding types. Use cweIds when a stable classification is needed.
product_version: Option<String>A vulnerability-taxonomy label: the producer’s category, sub-category, or OWASP category. Deliberately unconstrained beyond length – producers do not share a taxonomy, so this is NOT a stable filter key across finding types. Use cweIds when a stable classification is needed.
source_status: Option<String>The producer’s own status for the finding, and the enum value behind it. Distinct from status, which is Continuum’s lifecycle state – a producer may call a finding “New” while Continuum has it SUBMITTED.
source_status_id: Option<i32>The producer’s numeric enum value for sourceStatus.
first_seen_at: Option<DateTime>When the producer first observed the finding (finding_info.first_seen_time). The producer’s own clock, not Continuum’s.
finding_types: Option<Vec<String>>The producer’s own classification of the finding (finding_info.types).
vulnerabilities: Option<Vec<FindingVulnerability>>Every vulnerability the document reported. A document may report several; the flat cveId/cvssBaseScore/filePath/lineNumber members above carry the first one’s identity so a caller that only needs “what and where” does not have to walk this list.
resources: Option<Vec<FindingResource>>Resources the document named (resources[]).
posture: Option<FindingPosture>The compliance posture, for an Application Security Posture Finding. Absent for a vulnerability finding.
finding_id: StringThe unique identifier of the finding.
finding_arn: StringThe ARN of the finding.
environment_id: StringThe environment that owns the finding.
source: StringThe system that produced the finding.
source_finding_id: StringThe producer’s own identifier for the finding.
reported_at: DateTimeWhen the producer reported the finding – its own clock, which is not Continuum’s ingestion time. createdAt is when Continuum accepted it; these are genuinely different instants and a reader usually wants this one. For CreateCodeFinding, this is the submitted OCSF document’s own top-level time. For findings Continuum’s scanner produces, it is the finding’s own creation time. Continuum does not validate it for plausibility: a producer’s value is echoed as given, so a timestamp here asserts the unit and format, not that the instant is genuine.
status: FindingStatusThe current lifecycle status of the finding.
status_updated_at: DateTimeThe timestamp when the status last transitioned.
created_at: DateTimeThe timestamp when the finding was ingested.
scan_run_id: Option<String>The scan that produced the finding, when it came from one. For a finding Continuum’s scanner produced, this is the Continuum scan run (see GetCodeScan). For a finding submitted with CreateCodeFinding, it is the OCSF document’s metadata.correlation_uid, when that value is a valid ScanRunId. Absent when the finding did not come from a scan.
status_message: Option<String>Human-readable context about the current status.
discard_reason: Option<FindingDiscardReason>Why the finding was not escalated. Present only when status is DISCARDED.
discard_reasoning: Option<String>Customer-facing explanation accompanying discardReason.
duplicate_of_issue_id: Option<String>The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.
created_issue_id: Option<String>The issue Continuum created from this finding.
completed_at: Option<DateTime>When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.
Implementations§
Source§impl GetCodeFindingOutput
impl GetCodeFindingOutput
Sourcepub fn type(&self) -> &FindingType
pub fn type(&self) -> &FindingType
What kind of finding this is. Determines which of the type-specific members below are populated.
Sourcepub fn severity(&self) -> &FindingSeverityId
pub fn severity(&self) -> &FindingSeverityId
The finding’s severity.
Sourcepub fn detailed_description(&self) -> Option<&str>
pub fn detailed_description(&self) -> Option<&str>
The full analysis.
Sourcepub fn category(&self) -> Option<&str>
pub fn category(&self) -> Option<&str>
The producer’s vulnerability category. Not a stable filter key across finding types – see FindingCategory.
Sourcepub fn sub_category(&self) -> Option<&str>
pub fn sub_category(&self) -> Option<&str>
A more specific classification within category.
Sourcepub fn cwe_ids(&self) -> &[String]
pub fn cwe_ids(&self) -> &[String]
CWE identifiers classifying the finding.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cwe_ids.is_none().
Sourcepub fn owasp_category(&self) -> Option<&str>
pub fn owasp_category(&self) -> Option<&str>
The OWASP Top 10 category, when the producer supplies one.
Sourcepub fn mitigation(&self) -> Option<&str>
pub fn mitigation(&self) -> Option<&str>
How to fix the finding.
Sourcepub fn line_number(&self) -> Option<i32>
pub fn line_number(&self) -> Option<i32>
The 1-indexed line the finding is about. Bounds are enforced server-side rather than by a constraint trait: a numeric constraint generates a distinct newtype per enclosing structure, so the same concept would not share a type across the create input and the read output.
Sourcepub fn cve_id(&self) -> Option<&str>
pub fn cve_id(&self) -> Option<&str>
The CVE this finding reports, for software-composition findings. Both code types can carry one: a customer document supplies it under vulnerabilities[].cve, and Continuum’s scanner reports CVEs for dependency-manifest findings.
Sourcepub fn cvss_base_score(&self) -> Option<f64>
pub fn cvss_base_score(&self) -> Option<f64>
The CVSS base score accompanying cveId, when the producer supplies one, from 0.0 to 10.0. Not computed by Continuum. The range is enforced server-side, not by a @range trait – the smithy-rs server SDK does not support range constraints on double shapes (smithy-rs#2007).
Sourcepub fn affected_packages(&self) -> &[AffectedPackage]
pub fn affected_packages(&self) -> &[AffectedPackage]
Packages implicated by the finding.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .affected_packages.is_none().
Sourcepub fn vulnerable_code(&self) -> Option<&str>
pub fn vulnerable_code(&self) -> Option<&str>
The vulnerable code fragment.
Sourcepub fn relevant_inputs(&self) -> &[String]
pub fn relevant_inputs(&self) -> &[String]
User-controlled inputs that reach the vulnerability.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .relevant_inputs.is_none().
Sourcepub fn steps_to_reproduce(&self) -> &[String]
pub fn steps_to_reproduce(&self) -> &[String]
Steps to reproduce or exploit the finding.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .steps_to_reproduce.is_none().
Sourcepub fn validation(&self) -> Option<&FindingValidation>
pub fn validation(&self) -> Option<&FindingValidation>
The validator’s assessment. Absent when no validation ran.
Sourcepub fn end_line(&self) -> Option<i32>
pub fn end_line(&self) -> Option<i32>
The last line of the affected range, from the document’s affected_code[].end_line.
Sourcepub fn mitre_techniques(&self) -> &[String]
pub fn mitre_techniques(&self) -> &[String]
MITRE ATT&CK technique identifiers, from the document’s finding_info.attacks[].technique.uid.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mitre_techniques.is_none().
Sourcepub fn remediation_references(&self) -> &[String]
pub fn remediation_references(&self) -> &[String]
Remediation references, from the document’s vulnerabilities[].remediation.references.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .remediation_references.is_none().
Sourcepub fn ocsf_class(&self) -> Option<&FindingOcsfClass>
pub fn ocsf_class(&self) -> Option<&FindingOcsfClass>
The OCSF class the document declared. Determines whether posture is populated.
Sourcepub fn ocsf_schema_version(&self) -> Option<&str>
pub fn ocsf_schema_version(&self) -> Option<&str>
The OCSF schema version the producer wrote against (metadata.version).
Sourcepub fn product_name(&self) -> Option<&str>
pub fn product_name(&self) -> Option<&str>
The producing product and vendor (metadata.product).
Sourcepub fn product_vendor_name(&self) -> Option<&str>
pub fn product_vendor_name(&self) -> Option<&str>
A vulnerability-taxonomy label: the producer’s category, sub-category, or OWASP category. Deliberately unconstrained beyond length – producers do not share a taxonomy, so this is NOT a stable filter key across finding types. Use cweIds when a stable classification is needed.
Sourcepub fn product_version(&self) -> Option<&str>
pub fn product_version(&self) -> Option<&str>
A vulnerability-taxonomy label: the producer’s category, sub-category, or OWASP category. Deliberately unconstrained beyond length – producers do not share a taxonomy, so this is NOT a stable filter key across finding types. Use cweIds when a stable classification is needed.
Sourcepub fn source_status(&self) -> Option<&str>
pub fn source_status(&self) -> Option<&str>
The producer’s own status for the finding, and the enum value behind it. Distinct from status, which is Continuum’s lifecycle state – a producer may call a finding “New” while Continuum has it SUBMITTED.
Sourcepub fn source_status_id(&self) -> Option<i32>
pub fn source_status_id(&self) -> Option<i32>
The producer’s numeric enum value for sourceStatus.
Sourcepub fn first_seen_at(&self) -> Option<&DateTime>
pub fn first_seen_at(&self) -> Option<&DateTime>
When the producer first observed the finding (finding_info.first_seen_time). The producer’s own clock, not Continuum’s.
Sourcepub fn finding_types(&self) -> &[String]
pub fn finding_types(&self) -> &[String]
The producer’s own classification of the finding (finding_info.types).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .finding_types.is_none().
Sourcepub fn vulnerabilities(&self) -> &[FindingVulnerability]
pub fn vulnerabilities(&self) -> &[FindingVulnerability]
Every vulnerability the document reported. A document may report several; the flat cveId/cvssBaseScore/filePath/lineNumber members above carry the first one’s identity so a caller that only needs “what and where” does not have to walk this list.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vulnerabilities.is_none().
Sourcepub fn resources(&self) -> &[FindingResource]
pub fn resources(&self) -> &[FindingResource]
Resources the document named (resources[]).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resources.is_none().
Sourcepub fn posture(&self) -> Option<&FindingPosture>
pub fn posture(&self) -> Option<&FindingPosture>
The compliance posture, for an Application Security Posture Finding. Absent for a vulnerability finding.
Sourcepub fn finding_id(&self) -> &str
pub fn finding_id(&self) -> &str
The unique identifier of the finding.
Sourcepub fn finding_arn(&self) -> &str
pub fn finding_arn(&self) -> &str
The ARN of the finding.
Sourcepub fn environment_id(&self) -> &str
pub fn environment_id(&self) -> &str
The environment that owns the finding.
Sourcepub fn source_finding_id(&self) -> &str
pub fn source_finding_id(&self) -> &str
The producer’s own identifier for the finding.
Sourcepub fn reported_at(&self) -> &DateTime
pub fn reported_at(&self) -> &DateTime
When the producer reported the finding – its own clock, which is not Continuum’s ingestion time. createdAt is when Continuum accepted it; these are genuinely different instants and a reader usually wants this one. For CreateCodeFinding, this is the submitted OCSF document’s own top-level time. For findings Continuum’s scanner produces, it is the finding’s own creation time. Continuum does not validate it for plausibility: a producer’s value is echoed as given, so a timestamp here asserts the unit and format, not that the instant is genuine.
Sourcepub fn status(&self) -> &FindingStatus
pub fn status(&self) -> &FindingStatus
The current lifecycle status of the finding.
Sourcepub fn status_updated_at(&self) -> &DateTime
pub fn status_updated_at(&self) -> &DateTime
The timestamp when the status last transitioned.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The timestamp when the finding was ingested.
Sourcepub fn scan_run_id(&self) -> Option<&str>
pub fn scan_run_id(&self) -> Option<&str>
The scan that produced the finding, when it came from one. For a finding Continuum’s scanner produced, this is the Continuum scan run (see GetCodeScan). For a finding submitted with CreateCodeFinding, it is the OCSF document’s metadata.correlation_uid, when that value is a valid ScanRunId. Absent when the finding did not come from a scan.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
Human-readable context about the current status.
Sourcepub fn discard_reason(&self) -> Option<&FindingDiscardReason>
pub fn discard_reason(&self) -> Option<&FindingDiscardReason>
Why the finding was not escalated. Present only when status is DISCARDED.
Sourcepub fn discard_reasoning(&self) -> Option<&str>
pub fn discard_reasoning(&self) -> Option<&str>
Customer-facing explanation accompanying discardReason.
Sourcepub fn duplicate_of_issue_id(&self) -> Option<&str>
pub fn duplicate_of_issue_id(&self) -> Option<&str>
The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.
Sourcepub fn created_issue_id(&self) -> Option<&str>
pub fn created_issue_id(&self) -> Option<&str>
The issue Continuum created from this finding.
Sourcepub fn completed_at(&self) -> Option<&DateTime>
pub fn completed_at(&self) -> Option<&DateTime>
When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.
Source§impl GetCodeFindingOutput
impl GetCodeFindingOutput
Sourcepub fn builder() -> GetCodeFindingOutputBuilder
pub fn builder() -> GetCodeFindingOutputBuilder
Creates a new builder-style object to manufacture GetCodeFindingOutput.
Trait Implementations§
Source§impl Clone for GetCodeFindingOutput
impl Clone for GetCodeFindingOutput
Source§impl Debug for GetCodeFindingOutput
impl Debug for GetCodeFindingOutput
Source§impl PartialEq for GetCodeFindingOutput
impl PartialEq for GetCodeFindingOutput
Source§impl RequestId for GetCodeFindingOutput
impl RequestId for GetCodeFindingOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for GetCodeFindingOutput
Auto Trait Implementations§
impl Freeze for GetCodeFindingOutput
impl RefUnwindSafe for GetCodeFindingOutput
impl Send for GetCodeFindingOutput
impl Sync for GetCodeFindingOutput
impl Unpin for GetCodeFindingOutput
impl UnsafeUnpin for GetCodeFindingOutput
impl UnwindSafe for GetCodeFindingOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);