Struct HookResult 

pub struct HookResult {
    pub handled: bool,
    pub prevent_default: bool,
    pub stop_propagation: bool,
    pub value: Option<Value>,
    pub error: Option<String>,
    pub notices: Vec<Notice>,
    pub plugin: Option<String>,
}

Result returned by a plugin hook handler.

Fields

handled: bool

Whether the hook was handled.

prevent_default: bool

Whether to prevent default behavior.

stop_propagation: bool

Whether to stop propagation to other plugins.

value: Option<Value>

Return value from the hook (if any).

error: Option<String>

Error message (if hook failed).

notices: Vec<Notice>

Messages the plugin asked the explorer to show.

plugin: Option<String>

The plugin that produced this result, filled in by the manager.

Implementations

impl HookResult

pub fn ok() -> Self

Create a successful result.

pub fn with_value(value: impl Into<Value>) -> Self

Create a result with a return value.

pub fn error(message: impl Into<String>) -> Self

Create an error result.

pub fn prevent_default(self) -> Self

Mark this result as preventing default behavior.

pub fn stop_propagation(self) -> Self

Mark this result as stopping propagation.

pub fn is_ok(&self) -> bool

Check if the hook execution was successful.

pub fn is_err(&self) -> bool

Check if the hook had an error.

Trait Implementations

impl Clone for HookResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookResult

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

Formats the value using the given formatter.

impl Default for HookResult

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HookResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HookResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.