Struct grafana_plugin_sdk::data::Metadata

#[non_exhaustive]
pub struct Metadata {
    pub path: Option<String>,
    pub path_separator: Option<String>,
    pub custom: Option<Map<String, Value>>,
    pub stats: Option<Vec<QueryStat>>,
    pub notices: Option<Vec<Notice>>,
    pub channel: Option<Channel>,
    pub preferred_visualisation: Option<VisType>,
    pub executed_query_string: Option<String>,
}

Metadata about a Frame.

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.

path: Option<String>

A browsable path on the datasource.

path_separator: Option<String>

Defines the separator pattern to decode a hierarchy. The default separator is ‘/’.

custom: Option<Map<String, Value>>

Custom datasource specific values.

stats: Option<Vec<QueryStat>>

Query result statistics.

notices: Option<Vec<Notice>>

Additional information about the data in the frame that Grafana can display in the UI.

channel: Option<Channel>

Path to a stream in Grafana Live that has real-time updates for this data.

preferred_visualisation: Option<VisType>

The preferred visualisation option when used in Grafana’s Explore mode.

executed_query_string: Option<String>

The raw query sent to the underlying system after all macros and templating have been applied.

This will be shown in the query inspector if present.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Metadata

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Metadata