Struct PluginResponse

pub struct PluginResponse {
    pub kind: PluginResponseKind,
    pub close: bool,
    pub post_send: Option<Box<dyn FnOnce() + Send + Sync>>,
}

Available on crate feature handover only.

A response in reply to the request kvarnctl sent.

Fields

kind: PluginResponseKind

The kind of response.

close: bool

If the socket should be closed. Should ONLY be used when we are immediately shutting down.

post_send: Option<Box<dyn FnOnce() + Send + Sync>>

A function to run after sending the response.

Implementations

impl PluginResponse

pub fn new(kind: PluginResponseKind) -> Self

Creates a new response which doesn’t close the connection.

pub fn ok(data: impl Into<Vec<u8>>) -> Self

Creates a new OK response with content.

pub fn ok_empty() -> Self

Creates a new OK response without content.

pub fn error(data: impl Into<Vec<u8>>) -> Self

Creates a new response signalling an error, with content.

pub fn error_empty() -> Self

Creates a new response signalling an error, without content.

pub fn close(self) -> Self

Close the ctl socket after this is returned. Use this only is you shut Kvarn down immediately in your plugin.

pub fn post_send(self, f: impl FnOnce() + Send + Sync + 'static) -> Self

Add a callback to fun after the response is sent.

Trait Implementations

impl Debug for PluginResponse

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

Formats the value using the given formatter.