pub struct QueryExplainer { /* private fields */ }Expand description
Renders a QueryPlan in the requested ExplainFormat.
use oxirs_arq::explain::{QueryExplainer, ExplainFormat, QueryPlan, PlanNode, IndexType};
let plan = QueryPlan {
root: PlanNode::TripleScan {
pattern: "?s ?p ?o".into(),
index_used: IndexType::FullScan,
estimated_rows: 100_000,
},
estimated_cost: 12.5,
estimated_cardinality: 100_000,
};
let exp = QueryExplainer::builder().show_estimates(true).build();
let out = exp.explain_with_format(&plan, ExplainFormat::Json);
assert!(out.contains("\"type\""));Implementations§
Source§impl QueryExplainer
impl QueryExplainer
Sourcepub fn new() -> Self
pub fn new() -> Self
Create a new explainer with default settings (text format, all annotations shown).
Sourcepub fn builder() -> QueryExplainerBuilder
pub fn builder() -> QueryExplainerBuilder
Return a builder for fine-grained configuration.
Sourcepub fn explain(&self, plan: &QueryPlan) -> String
pub fn explain(&self, plan: &QueryPlan) -> String
Render the plan using the format configured at construction time.
Sourcepub fn explain_with_format(
&self,
plan: &QueryPlan,
format: ExplainFormat,
) -> String
pub fn explain_with_format( &self, plan: &QueryPlan, format: ExplainFormat, ) -> String
Render the plan in a specific format, overriding the configured default.
Sourcepub fn explain_text(&self, plan: &QueryPlan) -> String
pub fn explain_text(&self, plan: &QueryPlan) -> String
Render as an indented text tree.
Sourcepub fn explain_json(&self, plan: &QueryPlan) -> String
pub fn explain_json(&self, plan: &QueryPlan) -> String
Render as a JSON object.
Sourcepub fn explain_dot(&self, plan: &QueryPlan) -> String
pub fn explain_dot(&self, plan: &QueryPlan) -> String
Render as Graphviz DOT language.
Trait Implementations§
Source§impl Clone for QueryExplainer
impl Clone for QueryExplainer
Source§fn clone(&self) -> QueryExplainer
fn clone(&self) -> QueryExplainer
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for QueryExplainer
impl Debug for QueryExplainer
Auto Trait Implementations§
impl Freeze for QueryExplainer
impl RefUnwindSafe for QueryExplainer
impl Send for QueryExplainer
impl Sync for QueryExplainer
impl Unpin for QueryExplainer
impl UnsafeUnpin for QueryExplainer
impl UnwindSafe for QueryExplainer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.