Struct ExtensionArgs 

pub struct ExtensionArgs {
    pub positional: Vec<ExtensionValue>,
    pub named: IndexMap<String, ExtensionValue>,
    pub output_columns: Vec<ExtensionColumn>,
}

Represents extension arguments plus optional output columns.

Named arguments are stored in an IndexMap whose iteration order determines display order. Extension super::Explainable::to_args() implementations should insert named arguments in the order they should appear in the text format.

Fields

positional: Vec<ExtensionValue>

Positional arguments.

named: IndexMap<String, ExtensionValue>

Named arguments, displayed in the order they were inserted

output_columns: Vec<ExtensionColumn>

Output columns for custom relation types.

Implementations

impl ExtensionArgs

pub fn push<T>(&mut self, value: T)

where T: Into<ExtensionValue>,

Push a positional extension argument.

pub fn insert<K, V>(&mut self, name: K, value: V) -> Option<ExtensionValue>

where K: Into<String>, V: Into<ExtensionValue>,

Insert a named extension argument, returning any previous value.

pub fn extractor(&self) -> ArgsExtractor<'_>

Create an extractor for validating named arguments

Trait Implementations

impl Clone for ExtensionArgs

fn clone(&self) -> ExtensionArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtensionArgs

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

Formats the value using the given formatter.

impl Default for ExtensionArgs

fn default() -> ExtensionArgs

Returns the “default value” for a type.

impl Textify for ExtensionArgs

fn name() -> &'static str

fn textify<S: Scope, W: Write>(&self, ctx: &S, w: &mut W) -> Result