Struct gapi_grpc::google::spanner::v1::PlanNode

pub struct PlanNode {
    pub index: i32,
    pub kind: i32,
    pub display_name: String,
    pub child_links: Vec<ChildLink>,
    pub short_representation: Option<ShortRepresentation>,
    pub metadata: Option<Struct>,
    pub execution_stats: Option<Struct>,
}

Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].

Fields

index: i32

The PlanNode’s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].

kind: i32

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

display_name: String

The display name for the node.

child_links: Vec<ChildLink>

List of child node indexes and their relationship to this parent.

short_representation: Option<ShortRepresentation>

Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.

metadata: Option<Struct>

Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata:

{
  "parameter_reference": "param1",
  "parameter_type": "array"
}

execution_stats: Option<Struct>

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Implementations

impl PlanNode

pub fn kind(&self) -> Kind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: Kind)

Sets kind to the provided enum value.

Trait Implementations

impl Clone for PlanNode

fn clone(&self) -> PlanNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlanNode

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

Formats the value using the given formatter.

impl Default for PlanNode

fn default() -> PlanNode

Returns the “default value” for a type.

impl Message for PlanNode

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<PlanNode> for PlanNode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for PlanNode