Struct grafana_plugin_sdk::data::Notice

#[non_exhaustive]
pub struct Notice {
    pub severity: Option<Severity>,
    pub text: String,
    pub link: Option<String>,
    pub inspect: Option<InspectType>,
}

A notification to be displayed in Grafana’s UI.

Example

use grafana_plugin_sdk::{data::{Frame, Metadata, Notice, Severity}, prelude::*};

let mut notice = Notice::new("Isn't this a cool set of data?".to_string());
notice.severity = Some(Severity::Info);

let mut metadata = Metadata::default();
metadata.notices = Some(vec![notice]);

let frame = Frame::new("frame")
    .with_fields([
        [1_u32, 2, 3].into_field("x"),
        ["a", "b", "c"].into_field("y"),
    ])
    .with_metadata(metadata);

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.

severity: Option<Severity>

The severity level of this notice.

text: String

Freeform descriptive text to display on the notice.

link: Option<String>

An optional link to display in the Grafana UI.

Can be an absolute URL or a path relative to Grafana’s root URL.

inspect: Option<InspectType>

An optional suggestion for which tab to display in the panel inspector in Grafana’s UI.

Implementations

impl Notice

pub fn new(text: String) -> Self

Create a new Notice with the given text.

use grafana_plugin_sdk::data::Notice;

let notice = Notice::new("Isn't this a cool set of data?".to_string());

Trait Implementations

impl Clone for Notice

fn clone(&self) -> Notice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Notice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Notice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Notice

fn eq(&self, other: &Notice) -> 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 Notice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Notice

impl StructuralEq for Notice

impl StructuralPartialEq for Notice