Struct FunctionOption 

pub struct FunctionOption {
    pub name: String,
    pub preference: Vec<String>,
}

An optional function argument. Typically used for specifying behavior in invalid or corner cases.

Fields

name: String

Name of the option to set. If the consumer does not recognize the option, it must reject the plan. The name is matched case-insensitively with option names defined for the function.

preference: Vec<String>

List of behavior options allowed by the producer. At least one must be specified; to leave an option unspecified, simply don’t add an entry to options. The consumer must use the first option from the list that it supports. If the consumer supports none of the specified options, it must reject the plan. The name is matched case-insensitively and must match one of the option values defined for the option.

Trait Implementations

impl Clone for FunctionOption

fn clone(&self) -> FunctionOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionOption

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

Formats the value using the given formatter.

impl Default for FunctionOption

fn default() -> Self

Returns the “default value” for a type.

impl InputNode for FunctionOption

fn type_to_node() -> Node

Creates an empty output node for a protobuf datum of this type.

fn data_to_node(&self) -> Node

Creates an empty output node for a protobuf datum with this value.

fn oneof_variant(&self) -> Option<&'static str>

Returns the name of the selected variant of a oneof field, if this is a rust enum used to represent a oneof field.

fn parse_unknown(&self, y: &mut Context<'_>) -> bool

Complete the subtrees of this datum in output that have not already been parsed using UnknownField nodes. Returns whether any such nodes were added.

impl Message for FunctionOption

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FunctionOption

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

fn proto_message_type() -> &'static str

Returns the protobuf type name for messages of this type.

impl StructuralPartialEq for FunctionOption