Skip to main content

Event

malbox_plugin_sdk::prelude

Enum Event

pub enum Event {
Show 13 variants    TaskCreated {
        task_id: i32,
    },
    TaskStarting {
        task_id: i32,
    },
    TaskCompleted {
        task_id: i32,
    },
    TaskFailed {
        task_id: i32,
    },
    TaskCanceled {
        task_id: i32,
    },
    PluginStarted {
        plugin_id: i32,
    },
    PluginStopped {
        plugin_id: i32,
    },
    PluginResultAvailable {
        source: String,
        result_name: String,
    },
    SampleStarted {
        sample_id: i32,
    },
    SampleStopped {
        sample_id: i32,
    },
    SampleResultProduced {
        sample_id: i32,
    },
    DaemonShutdown,
    ConfigReloaded,
}

Expand description

A flat enumeration of all system-wide events.

Each variant carries its relevant data inline.

Variants§

TaskCreated

A task has been created and queued.

Fields

§task_id: i32

TaskStarting

A task is about to begin processing.

Fields

§task_id: i32

TaskCompleted

A task has finished processing.

Fields

§task_id: i32

TaskFailed

A task has failed processing.

Fields

§task_id: i32

TaskCanceled

A task has been canceled (e.g. due to worker shutdown).

Fields

§task_id: i32

PluginStarted

A plugin has started.

Fields

§plugin_id: i32

PluginStopped

A plugin has stopped.

Fields

§plugin_id: i32

PluginResultAvailable

A plugin has produced a result. This is a lightweight signal only - actual result data is accessed lazily via the result pub/sub channel through the macro-generated handler’s event wrapper.

Fields

§source: String

§result_name: String

SampleStarted

A sample has started.

Fields

§sample_id: i32

SampleStopped

A sample has stopped.

Fields

§sample_id: i32

SampleResultProduced

A sample has produced a result.

Fields

§sample_id: i32

DaemonShutdown

The daemon is shutting down.

ConfigReloaded

Configuration has been reloaded.

Trait Implementations§

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Event

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

Formats the value using the given formatter. Read more

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&EventHeader> for Event

type Error = u16

The type returned in the event of a conversion error.

fn try_from( header: &EventHeader, ) -> Result<Event, <Event as TryFrom<&EventHeader>>::Error>

Performs the conversion.

impl Eq for Event

impl StructuralPartialEq for Event

Auto Trait Implementations§

impl Freeze for Event

impl RefUnwindSafe for Event

impl Send for Event

impl Sync for Event

impl Unpin for Event

impl UnsafeUnpin for Event

impl UnwindSafe for Event

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more