Skip to main content

GetCodeFindingOutputBuilder

Struct GetCodeFindingOutputBuilder 

Source
#[non_exhaustive]
pub struct GetCodeFindingOutputBuilder { /* private fields */ }
Expand description

A builder for GetCodeFindingOutput.

Implementations§

Source§

impl GetCodeFindingOutputBuilder

Source

pub fn type(self, input: FindingType) -> Self

What kind of finding this is. Determines which of the type-specific members below are populated. This field is required.

Source

pub fn set_type(self, input: Option<FindingType>) -> Self

What kind of finding this is. Determines which of the type-specific members below are populated.

Source

pub fn get_type(&self) -> &Option<FindingType>

What kind of finding this is. Determines which of the type-specific members below are populated.

Source

pub fn title(self, input: impl Into<String>) -> Self

The producer’s title for the finding. This field is required.

Source

pub fn set_title(self, input: Option<String>) -> Self

The producer’s title for the finding.

Source

pub fn get_title(&self) -> &Option<String>

The producer’s title for the finding.

Source

pub fn severity(self, input: FindingSeverityId) -> Self

The finding’s severity. This field is required.

Source

pub fn set_severity(self, input: Option<FindingSeverityId>) -> Self

The finding’s severity.

Source

pub fn get_severity(&self) -> &Option<FindingSeverityId>

The finding’s severity.

Source

pub fn summary(self, input: impl Into<String>) -> Self

A one-paragraph description.

Source

pub fn set_summary(self, input: Option<String>) -> Self

A one-paragraph description.

Source

pub fn get_summary(&self) -> &Option<String>

A one-paragraph description.

Source

pub fn detailed_description(self, input: impl Into<String>) -> Self

The full analysis.

Source

pub fn set_detailed_description(self, input: Option<String>) -> Self

The full analysis.

Source

pub fn get_detailed_description(&self) -> &Option<String>

The full analysis.

Source

pub fn category(self, input: impl Into<String>) -> Self

The producer’s vulnerability category. Not a stable filter key across finding types – see FindingCategory.

Source

pub fn set_category(self, input: Option<String>) -> Self

The producer’s vulnerability category. Not a stable filter key across finding types – see FindingCategory.

Source

pub fn get_category(&self) -> &Option<String>

The producer’s vulnerability category. Not a stable filter key across finding types – see FindingCategory.

Source

pub fn sub_category(self, input: impl Into<String>) -> Self

A more specific classification within category.

Source

pub fn set_sub_category(self, input: Option<String>) -> Self

A more specific classification within category.

Source

pub fn get_sub_category(&self) -> &Option<String>

A more specific classification within category.

Source

pub fn cwe_ids(self, input: impl Into<String>) -> Self

Appends an item to cwe_ids.

To override the contents of this collection use set_cwe_ids.

CWE identifiers classifying the finding.

Source

pub fn set_cwe_ids(self, input: Option<Vec<String>>) -> Self

CWE identifiers classifying the finding.

Source

pub fn get_cwe_ids(&self) -> &Option<Vec<String>>

CWE identifiers classifying the finding.

Source

pub fn owasp_category(self, input: impl Into<String>) -> Self

The OWASP Top 10 category, when the producer supplies one.

Source

pub fn set_owasp_category(self, input: Option<String>) -> Self

The OWASP Top 10 category, when the producer supplies one.

Source

pub fn get_owasp_category(&self) -> &Option<String>

The OWASP Top 10 category, when the producer supplies one.

Source

pub fn mitigation(self, input: impl Into<String>) -> Self

How to fix the finding.

Source

pub fn set_mitigation(self, input: Option<String>) -> Self

How to fix the finding.

Source

pub fn get_mitigation(&self) -> &Option<String>

How to fix the finding.

Source

pub fn file_path(self, input: impl Into<String>) -> Self

The file the finding is about.

Source

pub fn set_file_path(self, input: Option<String>) -> Self

The file the finding is about.

Source

pub fn get_file_path(&self) -> &Option<String>

The file the finding is about.

Source

pub fn line_number(self, input: i32) -> Self

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.

Source

pub fn set_line_number(self, input: Option<i32>) -> Self

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.

Source

pub fn get_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.

Source

pub fn cve_id(self, input: impl Into<String>) -> Self

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.

Source

pub fn set_cve_id(self, input: Option<String>) -> Self

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.

Source

pub fn get_cve_id(&self) -> &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.

Source

pub fn cvss_base_score(self, input: f64) -> Self

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).

Source

pub fn set_cvss_base_score(self, input: Option<f64>) -> Self

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).

Source

pub fn get_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).

Source

pub fn affected_packages(self, input: AffectedPackage) -> Self

Appends an item to affected_packages.

To override the contents of this collection use set_affected_packages.

Packages implicated by the finding.

Source

pub fn set_affected_packages(self, input: Option<Vec<AffectedPackage>>) -> Self

Packages implicated by the finding.

Source

pub fn get_affected_packages(&self) -> &Option<Vec<AffectedPackage>>

Packages implicated by the finding.

Source

pub fn vulnerable_code(self, input: impl Into<String>) -> Self

The vulnerable code fragment.

Source

pub fn set_vulnerable_code(self, input: Option<String>) -> Self

The vulnerable code fragment.

Source

pub fn get_vulnerable_code(&self) -> &Option<String>

The vulnerable code fragment.

Source

pub fn relevant_inputs(self, input: impl Into<String>) -> Self

Appends an item to relevant_inputs.

To override the contents of this collection use set_relevant_inputs.

User-controlled inputs that reach the vulnerability.

Source

pub fn set_relevant_inputs(self, input: Option<Vec<String>>) -> Self

User-controlled inputs that reach the vulnerability.

Source

pub fn get_relevant_inputs(&self) -> &Option<Vec<String>>

User-controlled inputs that reach the vulnerability.

Source

pub fn steps_to_reproduce(self, input: impl Into<String>) -> Self

Appends an item to steps_to_reproduce.

To override the contents of this collection use set_steps_to_reproduce.

Steps to reproduce or exploit the finding.

Source

pub fn set_steps_to_reproduce(self, input: Option<Vec<String>>) -> Self

Steps to reproduce or exploit the finding.

Source

pub fn get_steps_to_reproduce(&self) -> &Option<Vec<String>>

Steps to reproduce or exploit the finding.

Source

pub fn validation(self, input: FindingValidation) -> Self

The validator’s assessment. Absent when no validation ran.

Source

pub fn set_validation(self, input: Option<FindingValidation>) -> Self

The validator’s assessment. Absent when no validation ran.

Source

pub fn get_validation(&self) -> &Option<FindingValidation>

The validator’s assessment. Absent when no validation ran.

Source

pub fn end_line(self, input: i32) -> Self

The last line of the affected range, from the document’s affected_code[].end_line.

Source

pub fn set_end_line(self, input: Option<i32>) -> Self

The last line of the affected range, from the document’s affected_code[].end_line.

Source

pub fn get_end_line(&self) -> &Option<i32>

The last line of the affected range, from the document’s affected_code[].end_line.

Source

pub fn mitre_techniques(self, input: impl Into<String>) -> Self

Appends an item to mitre_techniques.

To override the contents of this collection use set_mitre_techniques.

MITRE ATT&CK technique identifiers, from the document’s finding_info.attacks[].technique.uid.

Source

pub fn set_mitre_techniques(self, input: Option<Vec<String>>) -> Self

MITRE ATT&CK technique identifiers, from the document’s finding_info.attacks[].technique.uid.

Source

pub fn get_mitre_techniques(&self) -> &Option<Vec<String>>

MITRE ATT&CK technique identifiers, from the document’s finding_info.attacks[].technique.uid.

Source

pub fn remediation_references(self, input: impl Into<String>) -> Self

Appends an item to remediation_references.

To override the contents of this collection use set_remediation_references.

Remediation references, from the document’s vulnerabilities[].remediation.references.

Source

pub fn set_remediation_references(self, input: Option<Vec<String>>) -> Self

Remediation references, from the document’s vulnerabilities[].remediation.references.

Source

pub fn get_remediation_references(&self) -> &Option<Vec<String>>

Remediation references, from the document’s vulnerabilities[].remediation.references.

Source

pub fn ocsf_class(self, input: FindingOcsfClass) -> Self

The OCSF class the document declared. Determines whether posture is populated.

Source

pub fn set_ocsf_class(self, input: Option<FindingOcsfClass>) -> Self

The OCSF class the document declared. Determines whether posture is populated.

Source

pub fn get_ocsf_class(&self) -> &Option<FindingOcsfClass>

The OCSF class the document declared. Determines whether posture is populated.

Source

pub fn ocsf_schema_version(self, input: impl Into<String>) -> Self

The OCSF schema version the producer wrote against (metadata.version).

Source

pub fn set_ocsf_schema_version(self, input: Option<String>) -> Self

The OCSF schema version the producer wrote against (metadata.version).

Source

pub fn get_ocsf_schema_version(&self) -> &Option<String>

The OCSF schema version the producer wrote against (metadata.version).

Source

pub fn product_name(self, input: impl Into<String>) -> Self

The producing product and vendor (metadata.product).

Source

pub fn set_product_name(self, input: Option<String>) -> Self

The producing product and vendor (metadata.product).

Source

pub fn get_product_name(&self) -> &Option<String>

The producing product and vendor (metadata.product).

Source

pub fn product_vendor_name(self, input: impl Into<String>) -> Self

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

pub fn set_product_vendor_name(self, input: Option<String>) -> Self

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

pub fn get_product_vendor_name(&self) -> &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

pub fn product_version(self, input: impl Into<String>) -> Self

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

pub fn set_product_version(self, input: Option<String>) -> Self

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

pub fn get_product_version(&self) -> &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

pub fn source_status(self, input: impl Into<String>) -> Self

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

pub fn set_source_status(self, input: Option<String>) -> Self

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

pub fn get_source_status(&self) -> &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

pub fn source_status_id(self, input: i32) -> Self

The producer’s numeric enum value for sourceStatus.

Source

pub fn set_source_status_id(self, input: Option<i32>) -> Self

The producer’s numeric enum value for sourceStatus.

Source

pub fn get_source_status_id(&self) -> &Option<i32>

The producer’s numeric enum value for sourceStatus.

Source

pub fn first_seen_at(self, input: DateTime) -> Self

When the producer first observed the finding (finding_info.first_seen_time). The producer’s own clock, not Continuum’s.

Source

pub fn set_first_seen_at(self, input: Option<DateTime>) -> Self

When the producer first observed the finding (finding_info.first_seen_time). The producer’s own clock, not Continuum’s.

Source

pub fn get_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.

Source

pub fn finding_types(self, input: impl Into<String>) -> Self

Appends an item to finding_types.

To override the contents of this collection use set_finding_types.

The producer’s own classification of the finding (finding_info.types).

Source

pub fn set_finding_types(self, input: Option<Vec<String>>) -> Self

The producer’s own classification of the finding (finding_info.types).

Source

pub fn get_finding_types(&self) -> &Option<Vec<String>>

The producer’s own classification of the finding (finding_info.types).

Source

pub fn vulnerabilities(self, input: FindingVulnerability) -> Self

Appends an item to vulnerabilities.

To override the contents of this collection use set_vulnerabilities.

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.

Source

pub fn set_vulnerabilities( self, input: Option<Vec<FindingVulnerability>>, ) -> Self

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.

Source

pub fn get_vulnerabilities(&self) -> &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.

Source

pub fn resources(self, input: FindingResource) -> Self

Appends an item to resources.

To override the contents of this collection use set_resources.

Resources the document named (resources[]).

Source

pub fn set_resources(self, input: Option<Vec<FindingResource>>) -> Self

Resources the document named (resources[]).

Source

pub fn get_resources(&self) -> &Option<Vec<FindingResource>>

Resources the document named (resources[]).

Source

pub fn posture(self, input: FindingPosture) -> Self

The compliance posture, for an Application Security Posture Finding. Absent for a vulnerability finding.

Source

pub fn set_posture(self, input: Option<FindingPosture>) -> Self

The compliance posture, for an Application Security Posture Finding. Absent for a vulnerability finding.

Source

pub fn get_posture(&self) -> &Option<FindingPosture>

The compliance posture, for an Application Security Posture Finding. Absent for a vulnerability finding.

Source

pub fn finding_id(self, input: impl Into<String>) -> Self

The unique identifier of the finding. This field is required.

Source

pub fn set_finding_id(self, input: Option<String>) -> Self

The unique identifier of the finding.

Source

pub fn get_finding_id(&self) -> &Option<String>

The unique identifier of the finding.

Source

pub fn finding_arn(self, input: impl Into<String>) -> Self

The ARN of the finding. This field is required.

Source

pub fn set_finding_arn(self, input: Option<String>) -> Self

The ARN of the finding.

Source

pub fn get_finding_arn(&self) -> &Option<String>

The ARN of the finding.

Source

pub fn environment_id(self, input: impl Into<String>) -> Self

The environment that owns the finding. This field is required.

Source

pub fn set_environment_id(self, input: Option<String>) -> Self

The environment that owns the finding.

Source

pub fn get_environment_id(&self) -> &Option<String>

The environment that owns the finding.

Source

pub fn source(self, input: impl Into<String>) -> Self

The system that produced the finding. This field is required.

Source

pub fn set_source(self, input: Option<String>) -> Self

The system that produced the finding.

Source

pub fn get_source(&self) -> &Option<String>

The system that produced the finding.

Source

pub fn source_finding_id(self, input: impl Into<String>) -> Self

The producer’s own identifier for the finding. This field is required.

Source

pub fn set_source_finding_id(self, input: Option<String>) -> Self

The producer’s own identifier for the finding.

Source

pub fn get_source_finding_id(&self) -> &Option<String>

The producer’s own identifier for the finding.

Source

pub fn reported_at(self, input: DateTime) -> Self

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. This field is required.

Source

pub fn set_reported_at(self, input: Option<DateTime>) -> Self

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.

Source

pub fn get_reported_at(&self) -> &Option<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.

Source

pub fn status(self, input: FindingStatus) -> Self

The current lifecycle status of the finding. This field is required.

Source

pub fn set_status(self, input: Option<FindingStatus>) -> Self

The current lifecycle status of the finding.

Source

pub fn get_status(&self) -> &Option<FindingStatus>

The current lifecycle status of the finding.

Source

pub fn status_updated_at(self, input: DateTime) -> Self

The timestamp when the status last transitioned. This field is required.

Source

pub fn set_status_updated_at(self, input: Option<DateTime>) -> Self

The timestamp when the status last transitioned.

Source

pub fn get_status_updated_at(&self) -> &Option<DateTime>

The timestamp when the status last transitioned.

Source

pub fn created_at(self, input: DateTime) -> Self

The timestamp when the finding was ingested. This field is required.

Source

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The timestamp when the finding was ingested.

Source

pub fn get_created_at(&self) -> &Option<DateTime>

The timestamp when the finding was ingested.

Source

pub fn scan_run_id(self, input: impl Into<String>) -> Self

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.

Source

pub fn set_scan_run_id(self, input: Option<String>) -> Self

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.

Source

pub fn get_scan_run_id(&self) -> &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.

Source

pub fn status_message(self, input: impl Into<String>) -> Self

Human-readable context about the current status.

Source

pub fn set_status_message(self, input: Option<String>) -> Self

Human-readable context about the current status.

Source

pub fn get_status_message(&self) -> &Option<String>

Human-readable context about the current status.

Source

pub fn discard_reason(self, input: FindingDiscardReason) -> Self

Why the finding was not escalated. Present only when status is DISCARDED.

Source

pub fn set_discard_reason(self, input: Option<FindingDiscardReason>) -> Self

Why the finding was not escalated. Present only when status is DISCARDED.

Source

pub fn get_discard_reason(&self) -> &Option<FindingDiscardReason>

Why the finding was not escalated. Present only when status is DISCARDED.

Source

pub fn discard_reasoning(self, input: impl Into<String>) -> Self

Customer-facing explanation accompanying discardReason.

Source

pub fn set_discard_reasoning(self, input: Option<String>) -> Self

Customer-facing explanation accompanying discardReason.

Source

pub fn get_discard_reasoning(&self) -> &Option<String>

Customer-facing explanation accompanying discardReason.

Source

pub fn duplicate_of_issue_id(self, input: impl Into<String>) -> Self

The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.

Source

pub fn set_duplicate_of_issue_id(self, input: Option<String>) -> Self

The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.

Source

pub fn get_duplicate_of_issue_id(&self) -> &Option<String>

The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.

Source

pub fn created_issue_id(self, input: impl Into<String>) -> Self

The issue Continuum created from this finding.

Source

pub fn set_created_issue_id(self, input: Option<String>) -> Self

The issue Continuum created from this finding.

Source

pub fn get_created_issue_id(&self) -> &Option<String>

The issue Continuum created from this finding.

Source

pub fn completed_at(self, input: DateTime) -> Self

When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.

Source

pub fn set_completed_at(self, input: Option<DateTime>) -> Self

When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.

Source

pub fn get_completed_at(&self) -> &Option<DateTime>

When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.

Source

pub fn build(self) -> Result<GetCodeFindingOutput, BuildError>

Consumes the builder and constructs a GetCodeFindingOutput. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for GetCodeFindingOutputBuilder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GetCodeFindingOutputBuilder

Source§

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

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

impl Default for GetCodeFindingOutputBuilder

Source§

fn default() -> Self

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

impl PartialEq for GetCodeFindingOutputBuilder

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GetCodeFindingOutputBuilder

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
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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

Source§

impl<T> IntoEither for T

Source§

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

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

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

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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>

👎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());
Source§

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

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

§Example
println!("{}", value.resetting());
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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