Struct wasmcloud_control_interface::CtlResponse

#[non_exhaustive]
pub struct CtlResponse<T> { /* private fields */ }

A control interface response that wraps a response payload, a success flag, and a message with additional context if necessary.

Implementations

impl<T> CtlResponse<T>

pub fn ok(response: T) -> Self

Create a CtlResponse with provided response data

pub fn succeeded(&self) -> bool

Get whether the request succeeded

pub fn message(&self) -> &str

Get the message included in the response

pub fn data(&self) -> Option<&T>

Get the internal data of the response (if any)

pub fn into_data(self) -> Option<T>

Take the internal data

impl CtlResponse<()>

pub fn success(message: String) -> Self

Helper function to return a successful response without a message or a payload.

pub fn error(message: &str) -> Self

Helper function to return an unsuccessful response with a message but no payload. Note that this implicitly is typing the inner payload as () for efficiency.

Trait Implementations

impl<T: Clone> Clone for CtlResponse<T>

fn clone(&self) -> CtlResponse<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CtlResponse<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CtlResponse<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for CtlResponse<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.