Struct janus_plugin::PluginResult

pub struct PluginResult { /* fields omitted */ }

A Janus plugin result; what a plugin returns to the gateway as a direct response to a signalling message.

Implementations

impl PluginResult

pub unsafe fn new(
    type_: PluginResultType,
    text: *const c_char,
    content: *mut RawJanssonValue
) -> Self

Creates a new plugin result.

pub fn ok(response: JanssonValue) -> Self

Creates a plugin result indicating a synchronously successful request. The provided response JSON will be passed back to the client.

pub fn ok_wait(hint: Option<&'static CStr>) -> Self

Creates a plugin result indicating an asynchronous request in progress. If provided, the hint text will be synchronously passed back to the client in the acknowledgement.

pub fn error(msg: &'static CStr) -> Self

Creates a plugin result indicating an error. The provided error text will be synchronously passed back to the client.

pub fn into_raw(self) -> *mut RawPluginResult

Transfers ownership of this result to the wrapped raw pointer. The consumer is responsible for calling janus_plugin_result_destroy on the pointer when finished.

Trait Implementations

impl Debug for PluginResult

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

Formats the value using the given formatter.

impl Deref for PluginResult

type Target = RawPluginResult

The resulting type after dereferencing.

fn deref(&self) -> &RawPluginResult

Dereferences the value.

impl Drop for PluginResult

fn drop(&mut self)

Executes the destructor for this type.

impl Send for PluginResult