Struct grafana_plugin_sdk::backend::RunStreamRequest

#[non_exhaustive]
pub struct RunStreamRequest {
    pub plugin_context: PluginContext,
    pub path: Path,
    pub data: Bytes,
}

A request to ‘run’ a stream, i.e. begin streaming data.

This is made by Grafana after a stream subscription request has been accepted, and will include the same path as the subscription request.

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.

plugin_context: PluginContext

Metadata about the plugin from which the request originated.

path: Path

The subscription path; see module level comments for details.

data: Bytes

Optional raw data.

This may be used as an extra payload supplied upon subscription; for example, this may contain a JSON query object. This will be empty if not supplied in the query.

Trait Implementations

impl Debug for RunStreamRequest

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

Formats the value using the given formatter.

impl TryFrom<RunStreamRequest> for RunStreamRequest

type Error = ConvertFromError

The type returned in the event of a conversion error.

fn try_from(other: RunStreamRequest) -> Result<Self, Self::Error>

Performs the conversion.