Struct grafana_plugin_sdk::pluginv2::PluginContext

pub struct PluginContext {
    pub org_id: i64,
    pub plugin_id: String,
    pub user: Option<User>,
    pub app_instance_settings: Option<AppInstanceSettings>,
    pub data_source_instance_settings: Option<DataSourceInstanceSettings>,
}

Fields

org_id: i64

The Grafana organization id the request originating from.

plugin_id: String

The unique identifier of the plugin the request originating from.

user: Option<User>

The Grafana user the request originating from.

Will not be provided if Grafana backend initiated the request.

app_instance_settings: Option<AppInstanceSettings>

App plugin instance settings is the configured app instance settings. In Grafana an app instance is an enabled app plugin in a Grafana organization.

Will only be set if request targeting an app instance.

data_source_instance_settings: Option<DataSourceInstanceSettings>

Data source instance settings is the configured data source instance settings. In Grafana a data source instance is a created data source in a Grafana organization.

Will only be set if request targeting a data source instance.

Trait Implementations

impl Clone for PluginContext

fn clone(&self) -> PluginContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginContext

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

Formats the value using the given formatter.

impl Default for PluginContext

fn default() -> Self

Returns the “default value” for a type.

impl Message for PluginContext

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PluginContext

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

type Error = ConvertFromError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for PluginContext