Struct grafana_plugin_sdk::backend::PublishStreamResponse

#[non_exhaustive]
pub struct PublishStreamResponse {
    pub status: PublishStreamStatus,
    pub data: Value,
}

The response to a stream publish 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.

status: PublishStreamStatus

The status of the response.

data: Value

Data returned in response to publishing.

Implementations

impl PublishStreamResponse

pub fn new(status: PublishStreamStatus, data: Value) -> Self

👎Deprecated since 1.3.0:

use ok/not_found/permission_denied constructors instead

Create a new PublishStreamResponse.

pub fn ok(data: Value) -> Self

Create a PublishStreamResponse with status PublishStreamStatus::Ok.

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

pub fn not_found(details: Value) -> Self

Create a PublishStreamResponse with status PublishStreamStatus::NotFound.

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

pub fn permission_denied(details: Value) -> Self

Create a PublishStreamResponse with status PublishStreamStatus::PermissionDenied.

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

Trait Implementations

impl TryFrom<PublishStreamResponse> for PublishStreamResponse

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.