Skip to main content

ExplainExecutionNodeDescriptor

Struct ExplainExecutionNodeDescriptor 

Source
pub struct ExplainExecutionNodeDescriptor { /* private fields */ }
Expand description

ExplainExecutionNodeDescriptor

Canonical execution-node descriptor for EXPLAIN renderers. Optional fields are node-family specific.

Implementations§

Source§

impl ExplainExecutionNodeDescriptor

Source

pub const fn node_type(&self) -> ExplainExecutionNodeType

Return node type.

Source

pub const fn execution_mode(&self) -> ExplainExecutionMode

Return execution mode.

Source

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

Borrow optional access strategy annotation.

Source

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

Borrow optional predicate pushdown annotation.

Source

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

Borrow optional semantic scalar filter expression annotation.

Source

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

Borrow the optional explicit residual scalar filter expression.

Source

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

Borrow the optional derived residual predicate annotation emitted alongside filter_expr when execution still benefits from predicate pushdown labeling.

Source

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

Borrow optional projection annotation.

Source

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

Return optional ordering source annotation.

Source

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

Return optional limit annotation.

Source

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

Return optional continuation annotation.

Source

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

Return optional covering-scan annotation.

Source

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

Return optional row-count expectation annotation.

Source

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

Borrow child execution nodes.

Source

pub const fn node_properties(&self) -> &ExplainPropertyMap

Borrow node properties.

Source§

impl ExplainExecutionNodeDescriptor

Source

pub fn render_json_canonical(&self) -> String

Render this execution subtree as canonical JSON.

Source§

impl ExplainExecutionNodeDescriptor

Source

pub fn render_text_tree(&self) -> String

Render this execution subtree as a compact text tree.

Source

pub fn render_text_tree_verbose_with_indent(&self, indent: &str) -> String

Render this execution subtree as one verbose text tree with one caller-owned line prefix applied to every emitted line.

Trait Implementations§

Source§

impl Clone for ExplainExecutionNodeDescriptor

Source§

fn clone(&self) -> ExplainExecutionNodeDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExplainExecutionNodeDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ExplainExecutionNodeDescriptor

Source§

impl PartialEq for ExplainExecutionNodeDescriptor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ExplainExecutionNodeDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V