Struct ockam::Any

pub struct Any;

A passthrough marker message type.

This is a special message type which will enable your worker to accept any typed message, by ignoring the type information in the payload.

This is especially useful for implementing middleware workers which need access to the route information of a message, without understanding its payload.

Examples

use ockam::{hex, Any, Context, Result, Routed, Worker};

pub struct Logger;

#[ockam::worker]
impl Worker for Logger {
    type Context = Context;
    type Message = Any;

    /// This Worker will take any incoming message, print out the payload
    /// and then forward it to the next hop in its onward route.
    async fn handle_message(&mut self, ctx: &mut Context, msg: Routed<Any>) -> Result<()> {
        let mut local_msg = msg.into_local_message();
        let transport_msg = local_msg.transport_mut();
        transport_msg.onward_route.step()?;
        transport_msg.return_route.modify().prepend(ctx.address());

        let payload = transport_msg.payload.clone();

        if let Ok(str) = String::from_utf8(payload.clone()) {
            println!("Address: {}, Received string: {}", ctx.address(), str);
        } else {
            println!("Address: {}, Received binary: {}", ctx.address(), hex::encode(&payload));
        }

        ctx.forward(local_msg).await
    }
}

Trait Implementations

impl Clone for Any

fn clone(&self) -> Any

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Any

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

Formats the value using the given formatter.

impl Decodable for Any

fn decode(&[u8]) -> Result<Any, Error>

Decode a slice.

impl Display for Any

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

Formats the value using the given formatter.

impl Encodable for Any

fn encode(&self) -> Result<Vec<u8, Global>, Error>

Encode the type into an Encoded type.

impl PartialEq<Any> for Any

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Any

impl Message for Any

impl StructuralEq for Any

impl StructuralPartialEq for Any