Enum IncludeOption 

#[repr(i32)]
pub enum IncludeOption {
    Invalid = 0,
    WebSearchCallOutput = 1,
    XSearchCallOutput = 2,
    CodeExecutionCallOutput = 3,
    CollectionsSearchCallOutput = 4,
    DocumentSearchCallOutput = 5,
    McpCallOutput = 6,
    InlineCitations = 7,
}

Variants

Invalid = 0

Default value / invalid option.

WebSearchCallOutput = 1

Include the encrypted output from the web search tool in the response.

XSearchCallOutput = 2

Include the encrypted output from the X search tool in the response.

CodeExecutionCallOutput = 3

Include the plaintext output from the code execution tool in the response.

CollectionsSearchCallOutput = 4

Include the plaintext output from the collections search tool in the response.

DocumentSearchCallOutput = 5

Include the plaintext output from the document search tool in the response.

McpCallOutput = 6

Include the plaintext output from the MCP tool in the response.

InlineCitations = 7

Include the inline citations in the final response.

Implementations

impl IncludeOption

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of IncludeOption.

pub fn from_i32(value: i32) -> Option<IncludeOption>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a IncludeOption, or None if value is not a valid variant.

impl IncludeOption

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for IncludeOption

fn clone(&self) -> IncludeOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeOption

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

Formats the value using the given formatter.

impl Default for IncludeOption

fn default() -> IncludeOption

Returns the “default value” for a type.

impl From<IncludeOption> for i32

fn from(value: IncludeOption) -> i32

Converts to this type from the input type.

impl Hash for IncludeOption

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 IncludeOption

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IncludeOption

fn eq(&self, other: &IncludeOption) -> 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 PartialOrd for IncludeOption

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<i32> for IncludeOption

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<IncludeOption, UnknownEnumValue>

Performs the conversion.

impl Copy for IncludeOption

impl Eq for IncludeOption

impl StructuralPartialEq for IncludeOption