Enum IpcMethod 

pub enum IpcMethod {
    Hello,
    CurrentState,
    EventsSubscribe,
    LogsTail,
    CommandRestartChild,
    CommandPauseChild,
    CommandResumeChild,
    CommandQuarantineChild,
    CommandRemoveChild,
    CommandAddChild,
    CommandShutdownTree,
}

Typed IPC method accepted by the target process.

Variants

Hello

Protocol handshake.

CurrentState

Full dashboard state request.

EventsSubscribe

Event subscription request.

LogsTail

Log tail subscription request.

CommandRestartChild

Restart child command.

CommandPauseChild

Pause child command.

CommandResumeChild

Resume child command.

CommandQuarantineChild

Quarantine child command.

CommandRemoveChild

Remove child command.

CommandAddChild

Add child command.

CommandShutdownTree

Shutdown tree command.

Implementations

impl IpcMethod

pub fn parse(method: &str) -> Result<Self, DashboardError>

Parses a wire method and rejects unsupported aliases.

Arguments

• method: Method name from the request.

Returns

Returns a typed method or an unsupported-method error.

Examples found in repository

examples/demo/bootstrap.rs (line 344)

    async fn dispatch(&self, request: &IpcRequest) -> Result<IpcResult, DashboardError> {
        // Parse the request method.
        let method = IpcMethod::parse(&request.method)?;
        // Dispatch by method.
        match method {
            // Return protocol hello response.
            IpcMethod::Hello => Ok(IpcResult::Hello {
                // Include protocol version.
                protocol_version: DASHBOARD_IPC_PROTOCOL_VERSION.to_owned(),
                // Include registration payload.
                registration: build_registration_payload(&self.config)?,
                // End hello payload.
            }),
            // Return the current demo state.
            IpcMethod::CurrentState => {
                // Build current scenario state.
                let state = self.scenario.state();
                // Return state payload.
                Ok(IpcResult::State {
                    // Include target identifier.
                    target_id: state.target.target_id.clone(),
                    // Include boxed dashboard state.
                    state: Box::new(state),
                    // End state payload.
                })
                // End current state branch.
            }
            // Accept event subscription.
            IpcMethod::EventsSubscribe => Ok(self.subscription("events")),
            // Accept log subscription.
            IpcMethod::LogsTail => Ok(self.subscription("logs")),
            // Dispatch control command methods.
            IpcMethod::CommandRestartChild
            // Continue the demo expression.
            | IpcMethod::CommandPauseChild
            // Continue the demo expression.
            | IpcMethod::CommandResumeChild
            // Continue the demo expression.
            | IpcMethod::CommandQuarantineChild
            // Continue the demo expression.
            | IpcMethod::CommandRemoveChild
            // Continue the demo expression.
            | IpcMethod::CommandAddChild
            // Continue the demo expression.
            | IpcMethod::CommandShutdownTree => self.command_result(request),
            // End method match.
        }
        // End dispatch.
    }

pub fn as_str(&self) -> &'static str

Returns the canonical wire method name.

Arguments

This function has no arguments.

Returns

Returns the canonical method name.

Trait Implementations

impl Clone for IpcMethod

fn clone(&self) -> IpcMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpcMethod

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

Formats the value using the given formatter.

impl PartialEq for IpcMethod

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

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

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 Copy for IpcMethod

impl Eq for IpcMethod

impl StructuralPartialEq for IpcMethod