Struct fiberplane_models::providers::SupportedQueryType

#[non_exhaustive]
pub struct SupportedQueryType {
    pub label: String,
    pub query_type: String,
    pub schema: QuerySchema,
    pub mime_types: Vec<String>,
}

Defines a query type supported by a provider.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

label: String

User-friendly label to use for the query type.

query_type: String

The query type supported by the provider.

There are predefined query types, such as “table” and “log”, but providers may also implement custom query types, which it should prefix with “x-”.

schema: QuerySchema

The query schema defining the format of the query_data to be submitted with queries of this type.

mime_types: Vec<String>

MIME types supported for extraction. Any MIME type specified here should be valid as an argument to extract_data() when passed a response from queries of this type.

E.g.:

vec![
    "application/vnd.fiberplane.events",
    "application/vnd.fiberplane.metrics"
];

Implementations

impl SupportedQueryType

pub fn new(query_type: &str) -> Self

Creates a new query type with all default values.

pub fn supporting_mime_types(self, mime_types: &[&str]) -> Self

pub fn with_label(self, label: &str) -> Self

pub fn with_schema(self, schema: QuerySchema) -> Self

Trait Implementations

impl Debug for SupportedQueryType

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

Formats the value using the given formatter.

impl Default for SupportedQueryType

fn default() -> SupportedQueryType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SupportedQueryType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SupportedQueryType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.