Struct ockam_core::RouteBuilder

pub struct RouteBuilder<'r> { /* private fields */ }

A utility type for building and manipulating routes.

Implementations

impl RouteBuilder<'_>

pub fn append<A: Into<Address>>(self, addr: A) -> Self

Push a new item to the back of the route.

Examples

let builder: RouteBuilder = Route::new()
    .append("1#alice")
    .append("bob");

// ["1#alice, "0#bob"]
let route: Route = builder.into();

pub fn append_t<A: Into<String>>(self, ty: TransportType, addr: A) -> Self

Push an item with an explicit type to the back of the route.

Examples

let builder: RouteBuilder = Route::new()
    .append_t(TCP, "alice")
    .append_t(LOCAL, "bob");

// ["1#alice", "0#bob"]
let route: Route = builder.into();

pub fn prepend<A: Into<Address>>(self, addr: A) -> Self

Push a new item to the front of the route.

Examples

let builder: RouteBuilder = Route::new()
    .prepend("1#alice")
    .prepend("0#bob");

// ["0#bob", "1#alice"]
let route: Route = builder.into();

pub fn prepend_route(self, route: Route) -> Self

Prepend a full route to an existing route.

Examples

let mut route_a: Route = route!["1#alice", "bob"];
let route_b: Route = route!["1#carol", "dave"];

// ["1#carol", "0#dave", "1#alice", "0#bob"]
let route: Route = route_a.modify()
    .prepend_route(route_b)
    .into();

pub fn append_route(self, route: Route) -> Self

Append a full route to an existing route.

Examples

let mut route_a: Route = route!["1#alice", "bob"];
let route_b: Route = route!["1#carol", "dave"];

// ["1#alice", "0#bob", "1#carol", "0#dave"]
let route: Route = route_a.modify()
    .append_route(route_b)
    .into();

pub fn replace<A: Into<Address>>(self, addr: A) -> Self

Replace the next item in the route with a new address.

Similar to Self::prepend(...), but drops the previous HEAD value.

Examples

let mut route: Route = route!["1#alice", "bob"];

// ["1#carol", "0#bob"]
let route: Route = route.modify()
    .replace("1#carol")
    .into();

pub fn pop_front(self) -> Self

Pop the front item from the route.

Examples

let mut route: Route = route!["1#alice", "bob", "carol"];

// ["0#bob", "carol"]
let route: Route = route.modify()
    .pop_front()
    .into();

pub fn pop_back(self) -> Self

Pop the back item from the route.

Examples

let mut route: Route = route!["1#alice", "bob", "carol"];

// ["1#alice", "0#bob"]
let route: Route = route.modify()
    .pop_back()
    .into();

Trait Implementations

impl Default for RouteBuilder<'_>

fn default() -> Self

Returns the “default value” for a type.

impl Drop for RouteBuilder<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl From<RouteBuilder<'_>> for Route

Convert a RouteBuilder into a Route.

fn from(_: RouteBuilder<'_>) -> Self

Converts to this type from the input type.