Struct QueryTypeInfo 

pub struct QueryTypeInfo {
    pub name: String,
    pub description: String,
    pub required_params: Vec<String>,
    pub optional_params: Vec<String>,
    pub example: Option<Value>,
}

Information about a supported query type.

Fields

name: String

Query type name.

description: String

Description.

required_params: Vec<String>

Required parameters.

optional_params: Vec<String>

Optional parameters.

example: Option<Value>

Example usage.

Implementations

impl QueryTypeInfo

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Self

pub fn required(self, params: Vec<&str>) -> Self

pub fn optional(self, params: Vec<&str>) -> Self

pub fn example(self, example: impl Serialize) -> Self

Trait Implementations

impl Clone for QueryTypeInfo

fn clone(&self) -> QueryTypeInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryTypeInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryTypeInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryTypeInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.