Skip to main content

EventCategory

Enum EventCategory 

Source
pub enum EventCategory {
    Lifecycle,
    Hil,
    Echo,
    UserInput,
    Output,
    Extension {
        namespace: String,
        kind: String,
    },
}
Expand description

Event category for subscription-based routing.

Components declare which categories they subscribe to. The EventBus routes messages only to subscribers of the matching category.

Variants§

§

Lifecycle

System lifecycle events (init, shutdown, pause, resume).

All components implicitly subscribe to this category.

§

Hil

Human-in-the-Loop approval requests.

Operations: submit, status, list

§

Echo

Echo component (example/test).

Operations: echo, check

§

UserInput

User input from IOBridge.

Components subscribe to this category to receive user messages from the interactive console or other input sources.

Payload should contain:

  • message: The user’s input text (String)
§

Output

Output events for IO display.

Components emit this category when they want to output results to the user via IOBridge.

Payload should contain:

  • message: The message to display (String)
  • level: Optional log level (“info”, “warn”, “error”)
§

Extension

Extension category for plugins.

Use this for custom components that don’t fit built-in categories.

Fields

§namespace: String

Plugin/component namespace (e.g., “my-plugin”).

§kind: String

Event kind within the namespace (e.g., “data”, “notification”).

Implementations§

Source§

impl EventCategory

Source

pub fn extension( namespace: impl Into<String>, kind: impl Into<String>, ) -> EventCategory

Creates an Extension category.

§Example
use orcs_event::EventCategory;

let cat = EventCategory::extension("my-plugin", "data");
assert!(matches!(cat, EventCategory::Extension { .. }));
Source

pub fn is_lifecycle(&self) -> bool

Returns true if this is the Lifecycle category.

Source

pub fn is_hil(&self) -> bool

Returns true if this is the Hil category.

Source

pub fn is_extension(&self) -> bool

Returns true if this is an Extension category.

Source

pub fn is_output(&self) -> bool

Returns true if this is the Output category.

Source

pub fn is_user_input(&self) -> bool

Returns true if this is the UserInput category.

Source

pub fn name(&self) -> String

Returns the display name of this category.

Trait Implementations§

Source§

impl Clone for EventCategory

Source§

fn clone(&self) -> EventCategory

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
Source§

impl Debug for EventCategory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EventCategory

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<EventCategory, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for EventCategory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for EventCategory

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EventCategory

Source§

fn eq(&self, other: &EventCategory) -> 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.
Source§

impl Serialize for EventCategory

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for EventCategory

Source§

impl StructuralPartialEq for EventCategory

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,