Enum Modality 

#[non_exhaustive]
pub enum Modality {
    Unspecified,
    Text,
    Image,
    UnknownValue(UnknownValue),
}

This enum is used in the TemplateMetadata message to indicate the modality supported for sanitize API calls.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

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.

Unspecified

Unspecified modality. If specified, all modalities will be sanitized.

Text

Represents text modality. If specified, it will sanitize text fields, and text extracted from rich text files (like PDFs, DOCs) and plain text files (like TXT).

Image

Represents image modality. If specified, it will sanitize image files. The visual content and the text content in the image will be sanitized depending on the filter configuration.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using Modality::value or Modality::name.

Implementations

impl Modality

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

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for Modality

fn clone(&self) -> Modality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modality

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

Formats the value using the given formatter.

impl Default for Modality

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Modality

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Modality

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

Formats the value using the given formatter.

impl From<&str> for Modality

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for Modality

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for Modality

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Modality

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Modality