Enum aws_sdk_comprehend::model::InputFormat

#[non_exhaustive]
pub enum InputFormat {
    OneDocPerFile,
    OneDocPerLine,
    Unknown(UnknownVariantValue),
}

When writing a match expression against InputFormat, 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 inputformat = unimplemented!();
match inputformat {
    InputFormat::OneDocPerFile => { /* ... */ },
    InputFormat::OneDocPerLine => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when inputformat represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant InputFormat::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to InputFormat::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 InputFormat::NewFeature is defined. Specifically, when inputformat represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on InputFormat::NewFeature also yielding "NewFeature".

Explicitly matching on the Unknown variant should be avoided for two reasons:

• The inner data UnknownVariantValue is opaque, and no further information can be extracted.
• It might inadvertently shadow other intended match arms.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OneDocPerFile

OneDocPerLine

Unknown(UnknownVariantValue)

Unknown contains new variants that have been added since this code was generated.

Implementations

impl InputFormat

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 997)

    fn as_ref(&self) -> &str {
        self.as_str()
    }

src/json_ser.rs (line 2078)

pub fn serialize_structure_crate_model_input_data_config(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::InputDataConfig,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_407) = &input.s3_uri {
        object.key("S3Uri").string(var_407.as_str());
    }
    if let Some(var_408) = &input.input_format {
        object.key("InputFormat").string(var_408.as_str());
    }
    if let Some(var_409) = &input.document_reader_config {
        #[allow(unused_mut)]
        let mut object_410 = object.key("DocumentReaderConfig").start_object();
        crate::json_ser::serialize_structure_crate_model_document_reader_config(
            &mut object_410,
            var_409,
        )?;
        object_410.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_output_data_config(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::OutputDataConfig,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_411) = &input.s3_uri {
        object.key("S3Uri").string(var_411.as_str());
    }
    if let Some(var_412) = &input.kms_key_id {
        object.key("KmsKeyId").string(var_412.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_redaction_config(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::RedactionConfig,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_413) = &input.pii_entity_types {
        let mut array_414 = object.key("PiiEntityTypes").start_array();
        for item_415 in var_413 {
            {
                array_414.value().string(item_415.as_str());
            }
        }
        array_414.finish();
    }
    if let Some(var_416) = &input.mask_mode {
        object.key("MaskMode").string(var_416.as_str());
    }
    if let Some(var_417) = &input.mask_character {
        object.key("MaskCharacter").string(var_417.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_augmented_manifests_list_item(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::AugmentedManifestsListItem,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_418) = &input.s3_uri {
        object.key("S3Uri").string(var_418.as_str());
    }
    if let Some(var_419) = &input.split {
        object.key("Split").string(var_419.as_str());
    }
    if let Some(var_420) = &input.attribute_names {
        let mut array_421 = object.key("AttributeNames").start_array();
        for item_422 in var_420 {
            {
                array_421.value().string(item_422.as_str());
            }
        }
        array_421.finish();
    }
    if let Some(var_423) = &input.annotation_data_s3_uri {
        object.key("AnnotationDataS3Uri").string(var_423.as_str());
    }
    if let Some(var_424) = &input.source_documents_s3_uri {
        object.key("SourceDocumentsS3Uri").string(var_424.as_str());
    }
    if let Some(var_425) = &input.document_type {
        object.key("DocumentType").string(var_425.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_entity_types_list_item(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::EntityTypesListItem,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_426) = &input.r#type {
        object.key("Type").string(var_426.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_entity_recognizer_documents(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::EntityRecognizerDocuments,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_427) = &input.s3_uri {
        object.key("S3Uri").string(var_427.as_str());
    }
    if let Some(var_428) = &input.test_s3_uri {
        object.key("TestS3Uri").string(var_428.as_str());
    }
    if let Some(var_429) = &input.input_format {
        object.key("InputFormat").string(var_429.as_str());
    }
    Ok(())
}

pub const fn values() -> &'static [&'static str]

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for InputFormat

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for InputFormat

fn clone(&self) -> InputFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputFormat

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

Formats the value using the given formatter.

impl From<&str> for InputFormat

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for InputFormat

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for InputFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InputFormat

fn cmp(&self, other: &InputFormat) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<InputFormat> for InputFormat

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

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

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

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

impl PartialOrd<InputFormat> for InputFormat

fn partial_cmp(&self, other: &InputFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for InputFormat

impl StructuralEq for InputFormat

impl StructuralPartialEq for InputFormat