Struct grafana_plugin_sdk::backend::SubscribeStreamRequest

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

A request to subscribe to a stream.

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

Details of the plugin instance from which the request originated.

If the request originates from a datasource instance, this will include details about the datasource instance in the data_source_instance_settings field.

path: Path

The subscription channel path that the request wishes to subscribe to.

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 SubscribeStreamRequest

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

Formats the value using the given formatter.

impl TryFrom<SubscribeStreamRequest> for SubscribeStreamRequest

type Error = ConvertFromError

The type returned in the event of a conversion error.

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

Performs the conversion.