Struct CuvsOperationDescriptor 

pub struct CuvsOperationDescriptor {
    pub operation: CuvsOperation,
    pub sql_function_name: &'static str,
    pub display_name: &'static str,
    pub summary: &'static str,
    pub use_this_when: &'static str,
    pub relation_roles: &'static [CuvsRelationRole],
    pub vector_element_support: &'static [CuvsVectorElementSupport],
    pub output_contract: CuvsOutputContract,
    pub options: &'static [GpuOptionDefinition],
    pub output_fields: &'static [GpuOutputFieldDefinition],
    pub quickstart_sql: &'static str,
    pub limitations: &'static [&'static str],
}

One operation entry drives SQL names, relation shape, option metadata, and output-schema selection. Keep operation-specific facts in this registry.

Fields

operation: CuvsOperation

Identity selecting this registry entry.

sql_function_name: &'static str

Canonical table-function identifier.

display_name: &'static str

Human-readable function title; SQL names remain canonical identifiers.

summary: &'static str

Short catalog summary.

use_this_when: &'static str

Concrete selection guidance for the generated reference page.

relation_roles: &'static [CuvsRelationRole]

Relation arguments, each passed as a parenthesized subquery; the SQL surface admits no other relation syntax.

vector_element_support: &'static [CuvsVectorElementSupport]

Supported dense-vector element types for every relation binding.

output_contract: CuvsOutputContract

Result-shape family used to construct the Arrow schema.

options: &'static [GpuOptionDefinition]

Required options, accepted values, and defaults.

output_fields: &'static [GpuOutputFieldDefinition]

Ordered output field metadata, including repeated-field templates.

quickstart_sql: &'static str

Generic SQL that demonstrates the real execution syntax beyond the metadata-validation envelope.

limitations: &'static [&'static str]

Static and data-dependent lifecycle constraints that apply to this operation in addition to the common relation/validation contract.

Implementations

impl CuvsOperationDescriptor

pub fn element_support( &self, element: VectorElementType, ) -> Option<&CuvsVectorElementSupport>

Returns supported metrics for element, or None when the element type is unsupported.

pub fn option(&self, name: &str) -> Option<&'static GpuOptionDefinition>

Looks up an exact option name; returns None if this operation has no such option.

pub fn options_json_schema(&self) -> Value

Builds a draft 2020-12 JSON Schema for this operation’s options.

The schema includes defaults, supported relation element types, and required properties. Unknown properties are rejected; supported metric combinations are also included in the metric description.

Trait Implementations

impl Clone for CuvsOperationDescriptor

fn clone(&self) -> CuvsOperationDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CuvsOperationDescriptor

impl Debug for CuvsOperationDescriptor

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

Formats the value using the given formatter.

impl PartialEq for CuvsOperationDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CuvsOperationDescriptor