Struct GrainRef 

pub struct GrainRef { /* private fields */ }

A handle to a specific grain (interface + grain type + key) on which methods can be invoked.

GrainRef is cheap to clone and carries optional per-grain overrides for request context and timeout.

Implementations

impl GrainRef

pub fn interface_name(&self) -> &str

The grain interface name this reference targets.

pub fn grain_type(&self) -> &str

The grain type alias this reference targets.

pub fn key(&self) -> &GrainKey

The key this reference targets.

pub fn with_context(self, context: RequestContext) -> Self

Return a copy of this reference with request-context entries that are applied to every call made through it.

pub fn with_timeout(self, timeout: Duration) -> Self

Return a copy of this reference with a per-call deadline override.

pub async fn invoke( &self, method: &str, payload: Vec<u8>, codec: &str, ) -> Result<RawResponse, OrleansError>

Invoke method with an opaque, already-encoded payload under codec.

This is the lowest-level entry point; prefer GrainRef::invoke_json for typical use.

Errors

Returns an OrleansError on transport failure, timeout, or a structured bridge error.

pub async fn invoke_json<Req, Resp>( &self, method: &str, request: &Req, ) -> Result<Resp, OrleansError>

where Req: Serialize + ?Sized, Resp: DeserializeOwned,

Invoke method, serializing request to JSON and deserializing the JSON response.

Use a unit value (&()) for methods that take no argument.

Errors

Returns OrleansError::Serialization if (de)serialization fails, or a transport/bridge error otherwise.

pub async fn invoke_json_with_context<Req, Resp>( &self, method: &str, request: &Req, ) -> Result<(Resp, HashMap<String, String>), OrleansError>

where Req: Serialize + ?Sized, Resp: DeserializeOwned,

Like GrainRef::invoke_json, but also returns the response-context entries the grain produced.

Errors

See GrainRef::invoke_json.

pub async fn invoke_protobuf<Req, Resp>( &self, method: &str, request: &Req, ) -> Result<Resp, OrleansError>

where Req: Message, Resp: Message + Default,

Invoke method with a protobuf-encoded request and response.

The payload bytes are opaque to the bridge transport; the bridge’s grain invoker is responsible for decoding them.

Errors

Returns OrleansError::Serialization on decode failure, or a transport/bridge error otherwise.

Trait Implementations

impl Clone for GrainRef

fn clone(&self) -> GrainRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.