Struct grafana_plugin_sdk::live::Channel

pub struct Channel { /* fields omitted */ }

The identifier of a pub/sub channel in Grafana Live.

Channels are represented as / delimited strings containing their three components, and can be parsed from such strings using str::parse. When included in the Metadata of a Frame, channels are (de)serialized from this format.

// Note that the 'path' can contain '/'s.
let channel: Channel = "plugin/my-cool-plugin/streams/custom-streaming-feature"
    .parse()
    .expect("valid channel");
assert_eq!(channel.scope(), Scope::Plugin);
assert_eq!(channel.namespace().as_str(), "my-cool-plugin");
assert_eq!(channel.path().as_str(), "streams/custom-streaming-feature");
assert_eq!(
    channel.to_string(),
    String::from("plugin/my-cool-plugin/streams/custom-streaming-feature"),
);

See the channel guide for more information.

Implementations

impl Channel

pub fn new(scope: Scope, namespace: Namespace, path: Path) -> Self

Create a new channel from pre-validated parts.

pub fn scope(&self) -> Scope

Get the scope of this channel.

The scope determines the purpose of the channel; for example, channels used internally by Grafana have scope Grafana, while channels used by datasource plugins have scope Datasource.

pub fn namespace(&self) -> &Namespace

Get the namespace of this channel.

The namespace has a different meaning depending on scope:

• when scope is Scope::Grafana, namespace is a “feature”
• when scope is Scope::Plugin, namespace is the plugin name
• when scope is Scope::Datasource, namespace is the datasource uid.
• when scope is Scope::Stream, namespace is the stream ID.

For example, scope Grafana could have a namespace called dashboard, and all messages on such a channel would related to real-time dashboard events.

pub fn path(&self) -> &Path

Get the path of this channel.

The path usually contains the identifier of some concrete resource within a namespace, such as the ID of a dashboard that a user is currently looking at.

This can be anything the plugin author desires, provided it only includes the characters defined in the Path documentation.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl Display for Channel

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

Formats the value using the given formatter.

impl FromStr for Channel

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl PartialEq<Channel> for Channel

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

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

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

This method tests for !=.

impl StructuralPartialEq for Channel