Struct grafana_plugin_sdk::backend::SubscribeStreamResponse

#[non_exhaustive]
pub struct SubscribeStreamResponse {
    pub status: SubscribeStreamStatus,
    pub initial_data: Option<InitialData>,
}

The response to a stream subscription request.

This includes a status and some optional initial data for the 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.

status: SubscribeStreamStatus

The status of the response.

initial_data: Option<InitialData>

Optional initial data to return to the client, used to pre-populate the stream.

Implementations

impl SubscribeStreamResponse

pub fn new(
    status: SubscribeStreamStatus,
    initial_data: Option<InitialData>
) -> Self

👎Deprecated since 1.3.0:

use ok/not_found/permission_denied constructors instead

Create a new SubscribeStreamResponse.

pub fn ok(initial_data: Option<InitialData>) -> Self

Create a SubscribeStreamResponse with status SubscribeStreamStatus::Ok.

This is the happy path to be used when a subscription request succeeded.

pub fn not_found() -> Self

Create a SubscribeStreamResponse with status SubscribeStreamStatus::NotFound.

This should be returned when the caller requested an unknown path.

pub fn permission_denied() -> Self

Create a SubscribeStreamResponse with status SubscribeStreamStatus::PermissionDenied.

This should be returned when the caller is not permitted to access the requested path.

Trait Implementations

impl Debug for SubscribeStreamResponse

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

Formats the value using the given formatter.

impl From<SubscribeStreamResponse> for SubscribeStreamResponse

fn from(other: SubscribeStreamResponse) -> Self

Converts to this type from the input type.