Enum ClientMessage

pub enum ClientMessage {
    Result {
        seq: Seq,
        result: Option<Result<Serialized, Exception>>,
    },
    Log {
        level: LogLevel,
        message: String,
    },
    DebuggerMessage {
        debugger_actor_id: ActorId,
        action: DebuggerAction,
    },
}

Client messages. These define the messages that the controller can send to the client. The actual handling of these messages will be defined on the python side in the client implementation.

Variants

Result

A fetched result of an invoked operation.

Fields

seq: Seq

result: Option<Result<Serialized, Exception>>

Log

Notify the client of an event.

Fields

level: LogLevel

message: String

DebuggerMessage

Notify the client of a debugger event.

Fields

debugger_actor_id: ActorId

The actor id of the debugger.

action: DebuggerAction

The action to take.

Implementations

impl ClientMessage

pub fn is_result(&self) -> bool

Returns true if this is a ClientMessage::Result, otherwise false

pub fn as_result_mut( &mut self, ) -> Option<(&mut Seq, &mut Option<Result<Serialized, Exception>>)>

Optionally returns mutable references to the inner fields if this is a ClientMessage::Result, otherwise None

pub fn as_result( &self, ) -> Option<(&Seq, &Option<Result<Serialized, Exception>>)>

Optionally returns references to the inner fields if this is a ClientMessage::Result, otherwise None

pub fn into_result( self, ) -> Result<(Seq, Option<Result<Serialized, Exception>>), Self>

Returns the inner fields if this is a ClientMessage::Result, otherwise returns back the enum in the Err case of the result

pub fn is_log(&self) -> bool

Returns true if this is a ClientMessage::Log, otherwise false

pub fn as_log_mut(&mut self) -> Option<(&mut LogLevel, &mut String)>

Optionally returns mutable references to the inner fields if this is a ClientMessage::Log, otherwise None

pub fn as_log(&self) -> Option<(&LogLevel, &String)>

Optionally returns references to the inner fields if this is a ClientMessage::Log, otherwise None

pub fn into_log(self) -> Result<(LogLevel, String), Self>

Returns the inner fields if this is a ClientMessage::Log, otherwise returns back the enum in the Err case of the result

pub fn is_debugger_message(&self) -> bool

Returns true if this is a ClientMessage::DebuggerMessage, otherwise false

pub fn as_debugger_message_mut( &mut self, ) -> Option<(&mut ActorId, &mut DebuggerAction)>

Optionally returns mutable references to the inner fields if this is a ClientMessage::DebuggerMessage, otherwise None

pub fn as_debugger_message(&self) -> Option<(&ActorId, &DebuggerAction)>

Optionally returns references to the inner fields if this is a ClientMessage::DebuggerMessage, otherwise None

pub fn into_debugger_message(self) -> Result<(ActorId, DebuggerAction), Self>

Returns the inner fields if this is a ClientMessage::DebuggerMessage, otherwise returns back the enum in the Err case of the result

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Named for ClientMessage

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl Serialize for ClientMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RemoteHandles<ClientMessage> for ClientActor