Enum WorkerMessage

pub enum WorkerMessage {
    BackendNetworkInit(UniqueId),
    BackendNetworkPointToPointInit {
        from_stream: StreamRef,
        to_stream: StreamRef,
    },
    CallFunction(CallFunctionParams),
    CommandGroup(Vec<WorkerMessage>),
    CreateStream {
        id: StreamRef,
        stream_creation: StreamCreationMode,
    },
    CreateDeviceMesh {
        result: Ref,
        names: Vec<String>,
        ranks: Slice,
    },
    CreateRemoteProcessGroup {
        result: Ref,
        device_mesh: Ref,
        dims: Vec<String>,
    },
    BorrowCreate {
        result: Ref,
        borrow: u64,
        tensor: Ref,
        from_stream: StreamRef,
        to_stream: StreamRef,
    },
    BorrowFirstUse {
        borrow: u64,
    },
    BorrowLastUse {
        borrow: u64,
    },
    BorrowDrop {
        borrow: u64,
    },
    DeleteRefs(Vec<Ref>),
    RequestStatus {
        seq: Seq,
        controller: bool,
    },
    Reduce {
        result: Ref,
        tensor: Ref,
        factory: Factory,
        mesh: Ref,
        stream: StreamRef,
        dims: Vec<String>,
        reduction: Reduction,
        scatter: bool,
        in_place: bool,
        out: Option<Ref>,
    },
    SplitComm {
        dims: Vec<String>,
        device_mesh: Ref,
        stream: StreamRef,
        config: Option<NcclConfig>,
    },
    SplitCommForProcessGroup {
        remote_process_group: Ref,
        stream: StreamRef,
        config: Option<NcclConfig>,
    },
    SendTensor {
        result: Ref,
        from_ranks: Slice,
        to_ranks: Slice,
        tensor: Ref,
        factory: Factory,
        from_stream: StreamRef,
        to_stream: StreamRef,
    },
    CreatePipe {
        result: Ref,
        key: String,
        function: ResolvableFunction,
        max_messages: i64,
        mesh: Ref,
        args: Vec<WireValue>,
        kwargs: HashMap<String, WireValue>,
    },
    SendValue {
        seq: Seq,
        destination: Option<Ref>,
        mutates: Vec<Ref>,
        function: Option<ResolvableFunction>,
        args: Vec<WireValue>,
        kwargs: HashMap<String, WireValue>,
        stream: StreamRef,
    },
    SendResultOfActorCall(ActorCallParams),
    CallActorMethod(ActorMethodParams),
    PipeRecv {
        seq: Seq,
        results: Vec<Option<Ref>>,
        pipe: Ref,
        stream: StreamRef,
    },
    Exit {
        error: Option<(Option<ActorId>, String)>,
    },
    DefineRecording {
        result: Ref,
        nresults: usize,
        nformals: usize,
        commands: Vec<WorkerMessage>,
        ntotal_messages: usize,
        index: usize,
    },
    RecordingFormal {
        result: Ref,
        argument_index: usize,
        stream: StreamRef,
    },
    RecordingResult {
        result: Ref,
        output_index: usize,
        stream: StreamRef,
    },
    CallRecording {
        seq: Seq,
        recording: Ref,
        results: Vec<Ref>,
        actuals: Vec<Ref>,
    },
    SetRefUnitTestsOnly {
        reference: Ref,
        value: WireValue,
        stream: StreamRef,
    },
    GetRefUnitTestsOnly {
        value: Ref,
        stream: StreamRef,
        response_port: OncePortRef<Option<Result<WireValue, String>>>,
    },
}

Worker messages. These define the observable behavior of the worker, so the documentations here

Variants

BackendNetworkInit(UniqueId)

Initialize backend network state.

BackendNetworkPointToPointInit

Initialize backend network state for point-to-point communication.

Fields

from_stream: StreamRef

to_stream: StreamRef

CallFunction(CallFunctionParams)

Call a function, either a torch op or a Python remote_function.

CommandGroup(Vec<WorkerMessage>)

Groups commands together; these commands will be executed in order by the worker.

CreateStream

Create a [Stream] on the worker wih the provided id. Commands will be generally be scheduled onto streams to run; different streams can execute concurrently with one another.

Fields

id: StreamRef

Id of the stream to create.

stream_creation: StreamCreationMode

Whether to use the default device stream or create a new one.

CreateDeviceMesh

Create a [DeviceMesh] on the worker, which can be used to schedule efficient inter-worker communication.

Fields

result: Ref

names: Vec<String>

ranks: Slice

CreateRemoteProcessGroup

Create a PyTorch distributed process group on the worker, which can be used to schedule collectives in UDFs using monarch communicators.

Fields

result: Ref

device_mesh: Ref

dims: Vec<String>

BorrowCreate

Create a borrow of a tensor from one stream to another.

Borrows allows streams to access tensors on another stream. The runtime will insert appropriate synchronization to ensure that cross-stream usage is safe.

Fields

result: Ref

Ref of the resulting borrowed tensor

borrow: u64

Id for the borrow

tensor: Ref

Tensor to borrow

from_stream: StreamRef

Stream to borrow from

to_stream: StreamRef

Stream to borrow to

BorrowFirstUse

First use of the borrow on the receiving stream. This is a marker for synchronization.

Fields

borrow: u64

BorrowLastUse

Last use of the borrow on the receiving stream. This is a marker for synchronization.

Fields

borrow: u64

BorrowDrop

Drop the borrow and free the resources associated with it.

Fields

borrow: u64

DeleteRefs(Vec<Ref>)

Delete these refs from the worker state.

RequestStatus

A [ControllerMessage::Status] will be send to the controller when all streams have processed all the message sent before this one.

Fields

seq: Seq

controller: bool

Reduce

Perform a reduction operation, using an efficient communication backend. Only NCCL is supported for now.

Fields

result: Ref

Where to store the result of the reduction.

tensor: Ref

The tensor to reduce.

factory: Factory

Tensor metadata for tensor that can be used to construct a fresh tensor of appropriate size/shape. We use this if tensor isn’t accessible for some reason (like a previous error on the worker).

mesh: Ref

The device mesh on which to perform the reduction.

stream: StreamRef

The stream to call the reduction on.

dims: Vec<String>

The dimensions of the device mesh to reduce over. The members of these dimension will form the members of the reduction collective.

reduction: Reduction

What kind of reduction to perform.

scatter: bool

If true, the reduced result will be evenly split across the tensors of dim.

in_place: bool

If true, the reduction will be performed in-place on tensor.

out: Option<Ref>

Pre-existing tensor that should be used as the output for the reduction.

SplitComm

Create a new communicator on each rank in ranks, capable of communicating with its peers along the specified dimensions.

Fields

dims: Vec<String>

The device mesh dimensions along which the constructed communicator should be able to exchange data.

device_mesh: Ref

The device mesh associated with the new communicator. One communicator will be created for every member of the mesh.

stream: StreamRef

The stream associated with the communicator. Communicator operations will be ordered with respect to other operations scheduled on this stream.

config: Option<NcclConfig>

Configuration for the new communicator. If None, we will not pass a config object to nccl, which means that the created communicator will inherit its parent’s config.

SplitCommForProcessGroup

Create a new communicator on each rank in ranks, capable of communicating with its peers along the specified dimensions.

Fields

remote_process_group: Ref

The device mesh associated with the new communicator. One communicator will be created for every member of the mesh.

stream: StreamRef

The stream associated with the communicator. Communicator operations will be ordered with respect to other operations scheduled on this stream.

config: Option<NcclConfig>

Configuration for the new communicator. If None, we will not pass a config object to nccl, which means that the created communicator will inherit its parent’s config.

SendTensor

Fields

result: Ref

from_ranks: Slice

to_ranks: Slice

tensor: Ref

factory: Factory

from_stream: StreamRef

to_stream: StreamRef

CreatePipe

Fields

result: Ref

key: String

function: ResolvableFunction

max_messages: i64

mesh: Ref

args: Vec<WireValue>

kwargs: HashMap<String, WireValue>

SendValue

Fields

seq: Seq

destination: Option<Ref>

Pipe to send value to. If None, value is sent to controller.

mutates: Vec<Ref>

function: Option<ResolvableFunction>

Function to resolve the value to retrieve. If None, then args must contain the value as its only element and kwargs must be empty.

args: Vec<WireValue>

kwargs: HashMap<String, WireValue>

stream: StreamRef

The stream to retrieve from.

SendResultOfActorCall(ActorCallParams)

CallActorMethod(ActorMethodParams)

PipeRecv

Fields

seq: Seq

results: Vec<Option<Ref>>

Result refs.

pipe: Ref

Pipe to receive value from.

stream: StreamRef

The stream to retrieve from.

Exit

Finish processing all messages previously sent to this worker and stop the actor loop. Any streams will also be drained.

Fields

error: Option<(Option<ActorId>, String)>

Optional error reason if the exit is the result of an error, including

• optional actor id to indicate the source of the error
• error message or stacktrace The worker process will be stopped if the error is provided.

DefineRecording

Defines (part of) a new recording on the worker. This is a list of commands representing the execution of a function that was defined using monarch.compile. If there are too many commands to send in a single DefineRecording message, the commands may be chunked into ntotal_messages, with the index field indicating how to order the DefineRecording messages for a single recording.

Fields

result: Ref

The ref associated with this recording that will be used to call it in the future.

nresults: usize

The number of output tensors.

nformals: usize

The number of input tensors.

commands: Vec<WorkerMessage>

The list of commands to run.

ntotal_messages: usize

How many total DefineRecording messages make up this recording.

index: usize

This DefineRecording message’s index in the set of messages that make up this recording.

RecordingFormal

Defines an input tensor for a recording.

Fields

result: Ref

The ref that will be used to pass the input tensor to the recording.

argument_index: usize

The index of the input tensor in the list of input tensors.

stream: StreamRef

The stream that this input tensor will be used on.

RecordingResult

Defines an output tensor for a recording.

Fields

result: Ref

The ref that will be used to store the output tensor.

output_index: usize

The index of the output tensor in the list of output tensors.

stream: StreamRef

The stream that this output tensor will come from.

CallRecording

Calls a recording that was previously defined using DefineRecording.

Fields

seq: Seq

The sequence number of the invocation.

recording: Ref

The ref of the recording to call.

results: Vec<Ref>

The list of refs where the result tensors from the recording will be stored.

actuals: Vec<Ref>

The list of refs of input tensors to the recording.

SetRefUnitTestsOnly

Fields

reference: Ref

The reference to set.

value: WireValue

The value to set it with.

stream: StreamRef

The stream to set it on.

GetRefUnitTestsOnly

Fields

value: Ref

The value to retrieve, expected to be a bool.

stream: StreamRef

The stream to retrieve from.

response_port: OncePortRef<Option<Result<WireValue, String>>>

Implementations

impl WorkerMessage

pub fn is_backend_network_init(&self) -> bool

Returns true if this is a WorkerMessage::BackendNetworkInit, otherwise false

pub fn as_backend_network_init_mut(&mut self) -> Option<&mut UniqueId>

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

pub fn as_backend_network_init(&self) -> Option<&UniqueId>

Optionally returns references to the inner fields if this is a WorkerMessage::BackendNetworkInit, otherwise None

pub fn into_backend_network_init(self) -> Result<UniqueId, Self>

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

pub fn is_backend_network_point_to_point_init(&self) -> bool

Returns true if this is a WorkerMessage::BackendNetworkPointToPointInit, otherwise false

pub fn as_backend_network_point_to_point_init_mut( &mut self, ) -> Option<(&mut StreamRef, &mut StreamRef)>

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

pub fn as_backend_network_point_to_point_init( &self, ) -> Option<(&StreamRef, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::BackendNetworkPointToPointInit, otherwise None

pub fn into_backend_network_point_to_point_init( self, ) -> Result<(StreamRef, StreamRef), Self>

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

pub fn is_call_function(&self) -> bool

Returns true if this is a WorkerMessage::CallFunction, otherwise false

pub fn as_call_function_mut(&mut self) -> Option<&mut CallFunctionParams>

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

pub fn as_call_function(&self) -> Option<&CallFunctionParams>

Optionally returns references to the inner fields if this is a WorkerMessage::CallFunction, otherwise None

pub fn into_call_function(self) -> Result<CallFunctionParams, Self>

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

pub fn is_command_group(&self) -> bool

Returns true if this is a WorkerMessage::CommandGroup, otherwise false

pub fn as_command_group_mut(&mut self) -> Option<&mut Vec<WorkerMessage>>

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

pub fn as_command_group(&self) -> Option<&Vec<WorkerMessage>>

Optionally returns references to the inner fields if this is a WorkerMessage::CommandGroup, otherwise None

pub fn into_command_group(self) -> Result<Vec<WorkerMessage>, Self>

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

pub fn is_create_stream(&self) -> bool

Returns true if this is a WorkerMessage::CreateStream, otherwise false

pub fn as_create_stream_mut( &mut self, ) -> Option<(&mut StreamRef, &mut StreamCreationMode)>

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

pub fn as_create_stream(&self) -> Option<(&StreamRef, &StreamCreationMode)>

Optionally returns references to the inner fields if this is a WorkerMessage::CreateStream, otherwise None

pub fn into_create_stream(self) -> Result<(StreamRef, StreamCreationMode), Self>

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

pub fn is_create_device_mesh(&self) -> bool

Returns true if this is a WorkerMessage::CreateDeviceMesh, otherwise false

pub fn as_create_device_mesh_mut( &mut self, ) -> Option<(&mut Ref, &mut Vec<String>, &mut Slice)>

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

pub fn as_create_device_mesh(&self) -> Option<(&Ref, &Vec<String>, &Slice)>

Optionally returns references to the inner fields if this is a WorkerMessage::CreateDeviceMesh, otherwise None

pub fn into_create_device_mesh(self) -> Result<(Ref, Vec<String>, Slice), Self>

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

pub fn is_create_remote_process_group(&self) -> bool

Returns true if this is a WorkerMessage::CreateRemoteProcessGroup, otherwise false

pub fn as_create_remote_process_group_mut( &mut self, ) -> Option<(&mut Ref, &mut Ref, &mut Vec<String>)>

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

pub fn as_create_remote_process_group( &self, ) -> Option<(&Ref, &Ref, &Vec<String>)>

Optionally returns references to the inner fields if this is a WorkerMessage::CreateRemoteProcessGroup, otherwise None

pub fn into_create_remote_process_group( self, ) -> Result<(Ref, Ref, Vec<String>), Self>

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

pub fn is_borrow_create(&self) -> bool

Returns true if this is a WorkerMessage::BorrowCreate, otherwise false

pub fn as_borrow_create_mut( &mut self, ) -> Option<(&mut Ref, &mut u64, &mut Ref, &mut StreamRef, &mut StreamRef)>

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

pub fn as_borrow_create( &self, ) -> Option<(&Ref, &u64, &Ref, &StreamRef, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::BorrowCreate, otherwise None

pub fn into_borrow_create( self, ) -> Result<(Ref, u64, Ref, StreamRef, StreamRef), Self>

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

pub fn is_borrow_first_use(&self) -> bool

Returns true if this is a WorkerMessage::BorrowFirstUse, otherwise false

pub fn as_borrow_first_use_mut(&mut self) -> Option<&mut u64>

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

pub fn as_borrow_first_use(&self) -> Option<&u64>

Optionally returns references to the inner fields if this is a WorkerMessage::BorrowFirstUse, otherwise None

pub fn into_borrow_first_use(self) -> Result<u64, Self>

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

pub fn is_borrow_last_use(&self) -> bool

Returns true if this is a WorkerMessage::BorrowLastUse, otherwise false

pub fn as_borrow_last_use_mut(&mut self) -> Option<&mut u64>

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

pub fn as_borrow_last_use(&self) -> Option<&u64>

Optionally returns references to the inner fields if this is a WorkerMessage::BorrowLastUse, otherwise None

pub fn into_borrow_last_use(self) -> Result<u64, Self>

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

pub fn is_borrow_drop(&self) -> bool

Returns true if this is a WorkerMessage::BorrowDrop, otherwise false

pub fn as_borrow_drop_mut(&mut self) -> Option<&mut u64>

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

pub fn as_borrow_drop(&self) -> Option<&u64>

Optionally returns references to the inner fields if this is a WorkerMessage::BorrowDrop, otherwise None

pub fn into_borrow_drop(self) -> Result<u64, Self>

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

pub fn is_delete_refs(&self) -> bool

Returns true if this is a WorkerMessage::DeleteRefs, otherwise false

pub fn as_delete_refs_mut(&mut self) -> Option<&mut Vec<Ref>>

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

pub fn as_delete_refs(&self) -> Option<&Vec<Ref>>

Optionally returns references to the inner fields if this is a WorkerMessage::DeleteRefs, otherwise None

pub fn into_delete_refs(self) -> Result<Vec<Ref>, Self>

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

pub fn is_request_status(&self) -> bool

Returns true if this is a WorkerMessage::RequestStatus, otherwise false

pub fn as_request_status_mut(&mut self) -> Option<(&mut Seq, &mut bool)>

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

pub fn as_request_status(&self) -> Option<(&Seq, &bool)>

Optionally returns references to the inner fields if this is a WorkerMessage::RequestStatus, otherwise None

pub fn into_request_status(self) -> Result<(Seq, bool), Self>

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

pub fn is_reduce(&self) -> bool

Returns true if this is a WorkerMessage::Reduce, otherwise false

pub fn as_reduce_mut( &mut self, ) -> Option<(&mut Ref, &mut Ref, &mut Factory, &mut Ref, &mut StreamRef, &mut Vec<String>, &mut Reduction, &mut bool, &mut bool, &mut Option<Ref>)>

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

pub fn as_reduce( &self, ) -> Option<(&Ref, &Ref, &Factory, &Ref, &StreamRef, &Vec<String>, &Reduction, &bool, &bool, &Option<Ref>)>

Optionally returns references to the inner fields if this is a WorkerMessage::Reduce, otherwise None

pub fn into_reduce( self, ) -> Result<(Ref, Ref, Factory, Ref, StreamRef, Vec<String>, Reduction, bool, bool, Option<Ref>), Self>

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

pub fn is_split_comm(&self) -> bool

Returns true if this is a WorkerMessage::SplitComm, otherwise false

pub fn as_split_comm_mut( &mut self, ) -> Option<(&mut Vec<String>, &mut Ref, &mut StreamRef, &mut Option<NcclConfig>)>

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

pub fn as_split_comm( &self, ) -> Option<(&Vec<String>, &Ref, &StreamRef, &Option<NcclConfig>)>

Optionally returns references to the inner fields if this is a WorkerMessage::SplitComm, otherwise None

pub fn into_split_comm( self, ) -> Result<(Vec<String>, Ref, StreamRef, Option<NcclConfig>), Self>

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

pub fn is_split_comm_for_process_group(&self) -> bool

Returns true if this is a WorkerMessage::SplitCommForProcessGroup, otherwise false

pub fn as_split_comm_for_process_group_mut( &mut self, ) -> Option<(&mut Ref, &mut StreamRef, &mut Option<NcclConfig>)>

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

pub fn as_split_comm_for_process_group( &self, ) -> Option<(&Ref, &StreamRef, &Option<NcclConfig>)>

Optionally returns references to the inner fields if this is a WorkerMessage::SplitCommForProcessGroup, otherwise None

pub fn into_split_comm_for_process_group( self, ) -> Result<(Ref, StreamRef, Option<NcclConfig>), Self>

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

pub fn is_send_tensor(&self) -> bool

Returns true if this is a WorkerMessage::SendTensor, otherwise false

pub fn as_send_tensor_mut( &mut self, ) -> Option<(&mut Ref, &mut Slice, &mut Slice, &mut Ref, &mut Factory, &mut StreamRef, &mut StreamRef)>

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

pub fn as_send_tensor( &self, ) -> Option<(&Ref, &Slice, &Slice, &Ref, &Factory, &StreamRef, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::SendTensor, otherwise None

pub fn into_send_tensor( self, ) -> Result<(Ref, Slice, Slice, Ref, Factory, StreamRef, StreamRef), Self>

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

pub fn is_create_pipe(&self) -> bool

Returns true if this is a WorkerMessage::CreatePipe, otherwise false

pub fn as_create_pipe_mut( &mut self, ) -> Option<(&mut Ref, &mut String, &mut ResolvableFunction, &mut i64, &mut Ref, &mut Vec<WireValue>, &mut HashMap<String, WireValue>)>

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

pub fn as_create_pipe( &self, ) -> Option<(&Ref, &String, &ResolvableFunction, &i64, &Ref, &Vec<WireValue>, &HashMap<String, WireValue>)>

Optionally returns references to the inner fields if this is a WorkerMessage::CreatePipe, otherwise None

pub fn into_create_pipe( self, ) -> Result<(Ref, String, ResolvableFunction, i64, Ref, Vec<WireValue>, HashMap<String, WireValue>), Self>

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

pub fn is_send_value(&self) -> bool

Returns true if this is a WorkerMessage::SendValue, otherwise false

pub fn as_send_value_mut( &mut self, ) -> Option<(&mut Seq, &mut Option<Ref>, &mut Vec<Ref>, &mut Option<ResolvableFunction>, &mut Vec<WireValue>, &mut HashMap<String, WireValue>, &mut StreamRef)>

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

pub fn as_send_value( &self, ) -> Option<(&Seq, &Option<Ref>, &Vec<Ref>, &Option<ResolvableFunction>, &Vec<WireValue>, &HashMap<String, WireValue>, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::SendValue, otherwise None

pub fn into_send_value( self, ) -> Result<(Seq, Option<Ref>, Vec<Ref>, Option<ResolvableFunction>, Vec<WireValue>, HashMap<String, WireValue>, StreamRef), Self>

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

pub fn is_send_result_of_actor_call(&self) -> bool

Returns true if this is a WorkerMessage::SendResultOfActorCall, otherwise false

pub fn as_send_result_of_actor_call_mut( &mut self, ) -> Option<&mut ActorCallParams>

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

pub fn as_send_result_of_actor_call(&self) -> Option<&ActorCallParams>

Optionally returns references to the inner fields if this is a WorkerMessage::SendResultOfActorCall, otherwise None

pub fn into_send_result_of_actor_call(self) -> Result<ActorCallParams, Self>

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

pub fn is_call_actor_method(&self) -> bool

Returns true if this is a WorkerMessage::CallActorMethod, otherwise false

pub fn as_call_actor_method_mut(&mut self) -> Option<&mut ActorMethodParams>

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

pub fn as_call_actor_method(&self) -> Option<&ActorMethodParams>

Optionally returns references to the inner fields if this is a WorkerMessage::CallActorMethod, otherwise None

pub fn into_call_actor_method(self) -> Result<ActorMethodParams, Self>

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

pub fn is_pipe_recv(&self) -> bool

Returns true if this is a WorkerMessage::PipeRecv, otherwise false

pub fn as_pipe_recv_mut( &mut self, ) -> Option<(&mut Seq, &mut Vec<Option<Ref>>, &mut Ref, &mut StreamRef)>

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

pub fn as_pipe_recv( &self, ) -> Option<(&Seq, &Vec<Option<Ref>>, &Ref, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::PipeRecv, otherwise None

pub fn into_pipe_recv( self, ) -> Result<(Seq, Vec<Option<Ref>>, Ref, StreamRef), Self>

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

pub fn is_exit(&self) -> bool

Returns true if this is a WorkerMessage::Exit, otherwise false

pub fn as_exit_mut(&mut self) -> Option<&mut Option<(Option<ActorId>, String)>>

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

pub fn as_exit(&self) -> Option<&Option<(Option<ActorId>, String)>>

Optionally returns references to the inner fields if this is a WorkerMessage::Exit, otherwise None

pub fn into_exit(self) -> Result<Option<(Option<ActorId>, String)>, Self>

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

pub fn is_define_recording(&self) -> bool

Returns true if this is a WorkerMessage::DefineRecording, otherwise false

pub fn as_define_recording_mut( &mut self, ) -> Option<(&mut Ref, &mut usize, &mut usize, &mut Vec<WorkerMessage>, &mut usize, &mut usize)>

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

pub fn as_define_recording( &self, ) -> Option<(&Ref, &usize, &usize, &Vec<WorkerMessage>, &usize, &usize)>

Optionally returns references to the inner fields if this is a WorkerMessage::DefineRecording, otherwise None

pub fn into_define_recording( self, ) -> Result<(Ref, usize, usize, Vec<WorkerMessage>, usize, usize), Self>

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

pub fn is_recording_formal(&self) -> bool

Returns true if this is a WorkerMessage::RecordingFormal, otherwise false

pub fn as_recording_formal_mut( &mut self, ) -> Option<(&mut Ref, &mut usize, &mut StreamRef)>

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

pub fn as_recording_formal(&self) -> Option<(&Ref, &usize, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::RecordingFormal, otherwise None

pub fn into_recording_formal(self) -> Result<(Ref, usize, StreamRef), Self>

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

pub fn is_recording_result(&self) -> bool

Returns true if this is a WorkerMessage::RecordingResult, otherwise false

pub fn as_recording_result_mut( &mut self, ) -> Option<(&mut Ref, &mut usize, &mut StreamRef)>

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

pub fn as_recording_result(&self) -> Option<(&Ref, &usize, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::RecordingResult, otherwise None

pub fn into_recording_result(self) -> Result<(Ref, usize, StreamRef), Self>

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

pub fn is_call_recording(&self) -> bool

Returns true if this is a WorkerMessage::CallRecording, otherwise false

pub fn as_call_recording_mut( &mut self, ) -> Option<(&mut Seq, &mut Ref, &mut Vec<Ref>, &mut Vec<Ref>)>

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

pub fn as_call_recording(&self) -> Option<(&Seq, &Ref, &Vec<Ref>, &Vec<Ref>)>

Optionally returns references to the inner fields if this is a WorkerMessage::CallRecording, otherwise None

pub fn into_call_recording(self) -> Result<(Seq, Ref, Vec<Ref>, Vec<Ref>), Self>

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

pub fn is_set_ref_unit_tests_only(&self) -> bool

Returns true if this is a WorkerMessage::SetRefUnitTestsOnly, otherwise false

pub fn as_set_ref_unit_tests_only_mut( &mut self, ) -> Option<(&mut Ref, &mut WireValue, &mut StreamRef)>

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

pub fn as_set_ref_unit_tests_only( &self, ) -> Option<(&Ref, &WireValue, &StreamRef)>

Optionally returns references to the inner fields if this is a WorkerMessage::SetRefUnitTestsOnly, otherwise None

pub fn into_set_ref_unit_tests_only( self, ) -> Result<(Ref, WireValue, StreamRef), Self>

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

pub fn is_get_ref_unit_tests_only(&self) -> bool

Returns true if this is a WorkerMessage::GetRefUnitTestsOnly, otherwise false

pub fn as_get_ref_unit_tests_only_mut( &mut self, ) -> Option<(&mut Ref, &mut StreamRef, &mut OncePortRef<Option<Result<WireValue, String>>>)>

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

pub fn as_get_ref_unit_tests_only( &self, ) -> Option<(&Ref, &StreamRef, &OncePortRef<Option<Result<WireValue, String>>>)>

Optionally returns references to the inner fields if this is a WorkerMessage::GetRefUnitTestsOnly, otherwise None

pub fn into_get_ref_unit_tests_only( self, ) -> Result<(Ref, StreamRef, OncePortRef<Option<Result<WireValue, String>>>), Self>

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

Trait Implementations

impl Bind for WorkerMessage

fn bind(&mut self, bindings: &mut Bindings) -> Result<()>

Remove parameters from bindings, and use them to update itself.

impl Clone for WorkerMessage

fn clone(&self) -> WorkerMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkerMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Named for WorkerMessage

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 WorkerMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Unbind for WorkerMessage

fn unbind(&self, bindings: &mut Bindings) -> Result<()>

Extract parameters from itself and store them in bindings.

impl RemoteHandles<WorkerMessage> for WorkerActor