Enum Layout 

pub enum Layout {
    Solo {
        n_workers: usize,
    },
    Multihost {
        hosts: Vec<Host>,
        local_host_idx: usize,
    },
}

How a DBSP circuit is laid out across one or more machines.

Variants

Solo

A layout whose workers run on a single host.

Fields

n_workers: usize

The number of worker threads.

Multihost

A layout across multiple machines.

Fields

hosts: Vec<Host>

Each host in the layout. There should be two or more, each with a unique network address.

local_host_idx: usize

The index within hosts of the current host.

Implementations

impl Layout

pub fn new_solo(n_workers: usize) -> Layout

Returns a new solo layout with n_workers worker threads.

pub fn new_multihost( params: &[(SocketAddr, usize)], local_address: SocketAddr, ) -> Result<Layout, LayoutError>

Returns a new multihost layout with as many hosts as specified in params. Each tuple in params specifies a host’s unique network address and the number of workers to run on that host. local_address must be one of the addresses in params.

To execute such a multihost circuit, one must create a Runtime for it on every host in params, passing the same params in each case. Each host must pass its own local_address. The Runtime on each host listens on its own address and connects to all the other addresses.

pub fn local_workers(&self) -> Range<usize>

Returns the range of IDs for the workers on the local machine.

pub fn other_hosts(&self) -> impl Iterator<Item = &Host>

Returns an iterator over Hosts in this layout other than this one. If this is a single-host layout, this will be an empty iterator.

pub fn local_address(&self) -> Option<SocketAddr>

Returns the network address for the current machine, or None if this is a solo layout.

pub fn n_workers(&self) -> usize

Returns the total number of worker threads in this layout.

pub fn is_multihost(&self) -> bool

pub fn is_solo(&self) -> bool

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Layout

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Layout> for CircuitConfig

fn from(layout: Layout) -> Self

Converts to this type from the input type.

impl Serialize for Layout

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

where __S: Serializer,

Serialize this value into the given Serde serializer.