Struct Plan

pub struct Plan {
    pub version: Option<Version>,
    pub extension_uris: Vec<SimpleExtensionUri>,
    pub extensions: Vec<SimpleExtensionDeclaration>,
    pub relations: Vec<PlanRel>,
    pub advanced_extensions: Option<AdvancedExtension>,
    pub expected_type_urls: Vec<String>,
    pub parameter_bindings: Vec<DynamicParameterBinding>,
}

Describe a set of operations to complete. For compactness sake, identifiers are normalized at the plan level.

Fields

version: Option<Version>

Substrait version of the plan. Optional up to 0.17.0, required for later versions.

extension_uris: Vec<SimpleExtensionUri>

a list of yaml specifications this plan may depend on

extensions: Vec<SimpleExtensionDeclaration>

a list of extensions this plan may depend on

relations: Vec<PlanRel>

one or more relation trees that are associated with this plan.

advanced_extensions: Option<AdvancedExtension>

additional extensions associated with this plan.

expected_type_urls: Vec<String>

A list of com.google.Any entities that this plan may use. Can be used to warn if some embedded message types are unknown. Note that this list may include message types that are ignorable (optimizations) or that are unused. In many cases, a consumer may be able to work with a plan even if one or more message types defined here are unknown.

parameter_bindings: Vec<DynamicParameterBinding>

An optional list of bindings for dynamic parameters used in this plan. Each binding maps a parameter_anchor to its corresponding runtime value.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Plan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.

impl Default for Plan

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Plan

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Plan

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 Plan

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

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 Plan