#[non_exhaustive]pub enum OcsfStringField {
Show 70 variants
ActivityName,
ClassName,
CloudAccountName,
CloudAccountUid,
CloudProvider,
CloudRegion,
Comment,
ComplianceAssessmentsCategory,
ComplianceAssessmentsName,
ComplianceControl,
ComplianceStandards,
ComplianceStatus,
DatabucketEncryptionDetailsAlgorithm,
DatabucketEncryptionDetailsKeyUid,
DatabucketFileDataClassificationsClassifierDetailsType,
EvidencesActorUserAccountUid,
EvidencesApiOperation,
EvidencesApiResponseErrorMessage,
EvidencesApiServiceName,
EvidencesConnectionInfoDirection,
EvidencesConnectionInfoProtocolName,
EvidencesDstEndpointAutonomousSystemName,
EvidencesDstEndpointLocationCity,
EvidencesDstEndpointLocationCountry,
EvidencesSrcEndpointAutonomousSystemName,
EvidencesSrcEndpointHostname,
EvidencesSrcEndpointLocationCity,
EvidencesSrcEndpointLocationCountry,
FindingInfoAnalyticName,
FindingInfoDesc,
FindingInfoRelatedEventsProductUid,
FindingInfoRelatedEventsTitle,
FindingInfoRelatedEventsUid,
FindingInfoSrcUrl,
FindingInfoTitle,
FindingInfoTypes,
FindingInfoUid,
MalwareName,
MalwareSeverity,
MalwareScanInfoUid,
MetadataProductName,
MetadataProductUid,
MetadataProductVendorName,
MetadataUid,
RemediationDesc,
RemediationReferences,
ResourcesCloudFunctionLayersUidAlt,
ResourcesCloudFunctionRuntime,
ResourcesCloudFunctionUserUid,
ResourcesCloudPartition,
ResourcesDeviceEncryptionDetailsKeyUid,
ResourcesDeviceImageUid,
ResourcesImageArchitecture,
ResourcesImageRegistryUid,
ResourcesImageRepositoryName,
ResourcesImageUid,
ResourcesRegion,
ResourcesSubnetInfoUid,
ResourcesType,
ResourcesUid,
ResourcesVpcUid,
Severity,
Status,
VulnerabilitiesAffectedCodeFilePath,
VulnerabilitiesAffectedPackagesName,
VulnerabilitiesCveEpssScore,
VulnerabilitiesCveUid,
VulnerabilitiesFixCoverage,
VulnerabilitiesRelatedVulnerabilities,
Unknown(UnknownVariantValue),
}Expand description
When writing a match expression against OcsfStringField, it is important to ensure
your code is forward-compatible. That is, if a match arm handles a case for a
feature that is supported by the service but has not been represented as an enum
variant in a current version of SDK, your code should continue to work when you
upgrade SDK to a future version in which the enum does include a variant for that
feature.
Here is an example of how you can make a match expression forward-compatible:
# let ocsfstringfield = unimplemented!();
match ocsfstringfield {
OcsfStringField::ActivityName => { /* ... */ },
OcsfStringField::ClassName => { /* ... */ },
OcsfStringField::CloudAccountName => { /* ... */ },
OcsfStringField::CloudAccountUid => { /* ... */ },
OcsfStringField::CloudProvider => { /* ... */ },
OcsfStringField::CloudRegion => { /* ... */ },
OcsfStringField::Comment => { /* ... */ },
OcsfStringField::ComplianceAssessmentsCategory => { /* ... */ },
OcsfStringField::ComplianceAssessmentsName => { /* ... */ },
OcsfStringField::ComplianceControl => { /* ... */ },
OcsfStringField::ComplianceStandards => { /* ... */ },
OcsfStringField::ComplianceStatus => { /* ... */ },
OcsfStringField::DatabucketEncryptionDetailsAlgorithm => { /* ... */ },
OcsfStringField::DatabucketEncryptionDetailsKeyUid => { /* ... */ },
OcsfStringField::DatabucketFileDataClassificationsClassifierDetailsType => { /* ... */ },
OcsfStringField::EvidencesActorUserAccountUid => { /* ... */ },
OcsfStringField::EvidencesApiOperation => { /* ... */ },
OcsfStringField::EvidencesApiResponseErrorMessage => { /* ... */ },
OcsfStringField::EvidencesApiServiceName => { /* ... */ },
OcsfStringField::EvidencesConnectionInfoDirection => { /* ... */ },
OcsfStringField::EvidencesConnectionInfoProtocolName => { /* ... */ },
OcsfStringField::EvidencesDstEndpointAutonomousSystemName => { /* ... */ },
OcsfStringField::EvidencesDstEndpointLocationCity => { /* ... */ },
OcsfStringField::EvidencesDstEndpointLocationCountry => { /* ... */ },
OcsfStringField::EvidencesSrcEndpointAutonomousSystemName => { /* ... */ },
OcsfStringField::EvidencesSrcEndpointHostname => { /* ... */ },
OcsfStringField::EvidencesSrcEndpointLocationCity => { /* ... */ },
OcsfStringField::EvidencesSrcEndpointLocationCountry => { /* ... */ },
OcsfStringField::FindingInfoAnalyticName => { /* ... */ },
OcsfStringField::FindingInfoDesc => { /* ... */ },
OcsfStringField::FindingInfoRelatedEventsProductUid => { /* ... */ },
OcsfStringField::FindingInfoRelatedEventsTitle => { /* ... */ },
OcsfStringField::FindingInfoRelatedEventsUid => { /* ... */ },
OcsfStringField::FindingInfoSrcUrl => { /* ... */ },
OcsfStringField::FindingInfoTitle => { /* ... */ },
OcsfStringField::FindingInfoTypes => { /* ... */ },
OcsfStringField::FindingInfoUid => { /* ... */ },
OcsfStringField::MalwareName => { /* ... */ },
OcsfStringField::MalwareSeverity => { /* ... */ },
OcsfStringField::MalwareScanInfoUid => { /* ... */ },
OcsfStringField::MetadataProductName => { /* ... */ },
OcsfStringField::MetadataProductUid => { /* ... */ },
OcsfStringField::MetadataProductVendorName => { /* ... */ },
OcsfStringField::MetadataUid => { /* ... */ },
OcsfStringField::RemediationDesc => { /* ... */ },
OcsfStringField::RemediationReferences => { /* ... */ },
OcsfStringField::ResourcesCloudFunctionLayersUidAlt => { /* ... */ },
OcsfStringField::ResourcesCloudFunctionRuntime => { /* ... */ },
OcsfStringField::ResourcesCloudFunctionUserUid => { /* ... */ },
OcsfStringField::ResourcesCloudPartition => { /* ... */ },
OcsfStringField::ResourcesDeviceEncryptionDetailsKeyUid => { /* ... */ },
OcsfStringField::ResourcesDeviceImageUid => { /* ... */ },
OcsfStringField::ResourcesImageArchitecture => { /* ... */ },
OcsfStringField::ResourcesImageRegistryUid => { /* ... */ },
OcsfStringField::ResourcesImageRepositoryName => { /* ... */ },
OcsfStringField::ResourcesImageUid => { /* ... */ },
OcsfStringField::ResourcesRegion => { /* ... */ },
OcsfStringField::ResourcesSubnetInfoUid => { /* ... */ },
OcsfStringField::ResourcesType => { /* ... */ },
OcsfStringField::ResourcesUid => { /* ... */ },
OcsfStringField::ResourcesVpcUid => { /* ... */ },
OcsfStringField::Severity => { /* ... */ },
OcsfStringField::Status => { /* ... */ },
OcsfStringField::VulnerabilitiesAffectedCodeFilePath => { /* ... */ },
OcsfStringField::VulnerabilitiesAffectedPackagesName => { /* ... */ },
OcsfStringField::VulnerabilitiesCveEpssScore => { /* ... */ },
OcsfStringField::VulnerabilitiesCveUid => { /* ... */ },
OcsfStringField::VulnerabilitiesFixCoverage => { /* ... */ },
OcsfStringField::VulnerabilitiesRelatedVulnerabilities => { /* ... */ },
other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
_ => { /* ... */ },
}The above code demonstrates that when ocsfstringfield represents
NewFeature, the execution path will lead to the second last match arm,
even though the enum does not contain a variant OcsfStringField::NewFeature
in the current version of SDK. The reason is that the variable other,
created by the @ operator, is bound to
OcsfStringField::Unknown(UnknownVariantValue("NewFeature".to_owned()))
and calling as_str on it yields "NewFeature".
This match expression is forward-compatible when executed with a newer
version of SDK where the variant OcsfStringField::NewFeature is defined.
Specifically, when ocsfstringfield represents NewFeature,
the execution path will hit the second last match arm as before by virtue of
calling as_str on OcsfStringField::NewFeature also yielding "NewFeature".
Explicitly matching on the Unknown variant should
be avoided for two reasons:
- The inner data
UnknownVariantValueis opaque, and no further information can be extracted. - It might inadvertently shadow other intended match arms.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
ActivityName
ClassName
CloudAccountName
CloudAccountUid
CloudProvider
CloudRegion
Comment
ComplianceAssessmentsCategory
ComplianceAssessmentsName
ComplianceControl
ComplianceStandards
ComplianceStatus
DatabucketEncryptionDetailsAlgorithm
DatabucketEncryptionDetailsKeyUid
DatabucketFileDataClassificationsClassifierDetailsType
EvidencesActorUserAccountUid
EvidencesApiOperation
EvidencesApiResponseErrorMessage
EvidencesApiServiceName
EvidencesConnectionInfoDirection
EvidencesConnectionInfoProtocolName
EvidencesDstEndpointAutonomousSystemName
EvidencesDstEndpointLocationCity
EvidencesDstEndpointLocationCountry
EvidencesSrcEndpointAutonomousSystemName
EvidencesSrcEndpointHostname
EvidencesSrcEndpointLocationCity
EvidencesSrcEndpointLocationCountry
FindingInfoAnalyticName
FindingInfoDesc
FindingInfoRelatedEventsProductUid
FindingInfoRelatedEventsTitle
FindingInfoRelatedEventsUid
FindingInfoSrcUrl
FindingInfoTitle
FindingInfoTypes
FindingInfoUid
MalwareName
MalwareSeverity
MalwareScanInfoUid
MetadataProductName
MetadataProductUid
MetadataProductVendorName
MetadataUid
RemediationDesc
RemediationReferences
ResourcesCloudFunctionLayersUidAlt
ResourcesCloudFunctionRuntime
ResourcesCloudFunctionUserUid
ResourcesCloudPartition
ResourcesDeviceEncryptionDetailsKeyUid
ResourcesDeviceImageUid
ResourcesImageArchitecture
ResourcesImageRegistryUid
ResourcesImageRepositoryName
ResourcesImageUid
ResourcesRegion
ResourcesSubnetInfoUid
ResourcesType
ResourcesUid
ResourcesVpcUid
Severity
Status
VulnerabilitiesAffectedCodeFilePath
VulnerabilitiesAffectedPackagesName
VulnerabilitiesCveEpssScore
VulnerabilitiesCveUid
VulnerabilitiesFixCoverage
VulnerabilitiesRelatedVulnerabilities
Unknown(UnknownVariantValue)
Unknown. See the docs on this enum for the correct way to handle unknown variants.Unknown contains new variants that have been added since this code was generated.
Implementations§
Source§impl OcsfStringField
impl OcsfStringField
Sourcepub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
Parses the enum value while disallowing unknown variants.
Unknown variants will result in an error.
Trait Implementations§
Source§impl AsRef<str> for OcsfStringField
impl AsRef<str> for OcsfStringField
Source§impl Clone for OcsfStringField
impl Clone for OcsfStringField
Source§fn clone(&self) -> OcsfStringField
fn clone(&self) -> OcsfStringField
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for OcsfStringField
impl Debug for OcsfStringField
Source§impl Display for OcsfStringField
impl Display for OcsfStringField
Source§impl From<&str> for OcsfStringField
impl From<&str> for OcsfStringField
Source§impl FromStr for OcsfStringField
impl FromStr for OcsfStringField
Source§impl Hash for OcsfStringField
impl Hash for OcsfStringField
Source§impl Ord for OcsfStringField
impl Ord for OcsfStringField
Source§fn cmp(&self, other: &OcsfStringField) -> Ordering
fn cmp(&self, other: &OcsfStringField) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for OcsfStringField
impl PartialEq for OcsfStringField
Source§impl PartialOrd for OcsfStringField
impl PartialOrd for OcsfStringField
impl Eq for OcsfStringField
impl StructuralPartialEq for OcsfStringField
Auto Trait Implementations§
impl Freeze for OcsfStringField
impl RefUnwindSafe for OcsfStringField
impl Send for OcsfStringField
impl Sync for OcsfStringField
impl Unpin for OcsfStringField
impl UnwindSafe for OcsfStringField
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.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>
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);