Enum Mode 

#[non_exhaustive]
pub enum Mode {
    Unspecified,
    DropCrowdedResults,
    DemoteCrowdedResultsToEnd,
    UnknownValue(UnknownValue),
}

Available on crate features assistant-service or conversational-search-service or search-service or serving-config-service only.

Enum describing the mode to use for documents that are crowded away. They can be dropped or demoted to the later pages.

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 crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.

DropCrowdedResults

Drop crowded results.

DemoteCrowdedResultsToEnd

Demote crowded results to the later pages.

UnknownValue(UnknownValue)

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

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

Implementations

impl Mode

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 Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Mode

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Mode

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

Formats the value using the given formatter.

impl From<&str> for Mode

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for Mode

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for Mode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Mode

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 Mode