Struct ExplainExecutionNodeDescriptor 

pub struct ExplainExecutionNodeDescriptor { /* private fields */ }

ExplainExecutionNodeDescriptor

Canonical execution-node descriptor used by EXPLAIN text/verbose/json renderers. Optional fields are node-family specific and are additive.

Implementations

impl ExplainExecutionNodeDescriptor

pub const fn node_type(&self) -> ExplainExecutionNodeType

Return node type.

pub const fn execution_mode(&self) -> ExplainExecutionMode

Return execution mode.

pub const fn access_strategy(&self) -> Option<&ExplainAccessPath>

Borrow optional access strategy annotation.

pub fn predicate_pushdown(&self) -> Option<&str>

Borrow optional predicate pushdown annotation.

pub const fn residual_predicate(&self) -> Option<&ExplainPredicate>

Borrow optional residual predicate annotation.

pub fn projection(&self) -> Option<&str>

Borrow optional projection annotation.

pub const fn ordering_source(&self) -> Option<ExplainExecutionOrderingSource>

Return optional ordering source annotation.

pub const fn limit(&self) -> Option<u32>

Return optional limit annotation.

pub const fn cursor(&self) -> Option<bool>

Return optional continuation annotation.

pub const fn covering_scan(&self) -> Option<bool>

Return optional covering-scan annotation.

pub const fn rows_expected(&self) -> Option<u64>

Return optional row-count expectation annotation.

pub const fn children(&self) -> &[Self]

Borrow child execution nodes.

pub const fn node_properties(&self) -> &BTreeMap<String, Value>

Borrow node properties.

pub fn render_text_tree(&self) -> String

pub fn render_json_canonical(&self) -> String

pub fn render_text_tree_verbose(&self) -> String

Trait Implementations

impl Clone for ExplainExecutionNodeDescriptor

fn clone(&self) -> ExplainExecutionNodeDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainExecutionNodeDescriptor

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

Formats the value using the given formatter.

impl PartialEq for ExplainExecutionNodeDescriptor

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

impl StructuralPartialEq for ExplainExecutionNodeDescriptor