Struct NetworkingConfig 

pub struct NetworkingConfig<Tr: ?Sized, S: ?Sized, Name = ()> { /* private fields */ }

A network channel configuration with T as transport backend and S as the serialization backend.

Implementations

impl<Tr: ?Sized, S: ?Sized> NetworkingConfig<Tr, S>

pub fn name(self, name: impl Into<String>) -> NetworkingConfig<Tr, S, String>

Names the network channel and enables stable communication across multiple service versions.

impl<Tr: ?Sized, N> NetworkingConfig<Tr, NoSer, N>

pub const fn bincode(self) -> NetworkingConfig<Tr, Bincode, N>

Configures the network channel to use bincode to serialize items.

pub const fn embedded(self) -> NetworkingConfig<Tr, Embedded, N>

Configures the network channel to leave serialization to code outside of Hydro.

This is only supported by the embedded deployment backend (it will panic on all other backends). The generated network channel exposes the raw element type to the developer (rather than serialized bytes), so they can perform custom serialization logic outside of the Hydro program for that channel.

impl<S: ?Sized> NetworkingConfig<Tcp<()>, S>

pub const fn fail_stop(self) -> NetworkingConfig<Tcp<FailStop>, S>

Configures the TCP transport to stop sending messages after a failed connection.

Note that the Hydro simulator will not simulate connection failures that impact the liveness of a program. If an output assertion depends on a fail_stop channel making progress, that channel will not experience a failure that would cause the test to block indefinitely. However, any safety issues caused by connection failures will still be caught, such as a race condition between a failed connection and some other message.

pub const fn lossy(self, nondet: NonDet) -> NetworkingConfig<Tcp<Lossy>, S>

Configures the TCP transport to allow messages to be lost.

This is appropriate for networks where messages may be dropped, such as when running under a Maelstrom partition nemesis. Unlike fail_stop, which guarantees a prefix of messages is delivered, lossy makes no such guarantee.

Non-Determinism

A lossy TCP channel will non-deterministically drop messages during execution.

pub const fn lossy_delayed_forever( self, ) -> NetworkingConfig<Tcp<LossyDelayedForever>, S>

Configures the TCP transport to treat dropped messages as indefinitely delayed.

This is appropriate for networks where messages may be dropped, such as when running under a Maelstrom partition nemesis. Unlike Self::lossy, this does not require a NonDet annotation because the output is always lower in the partial order than the ideal stream. However, the output stream will have NoOrder guarantees, imposing stricter conditions on downstream consumers.

Unlike Self::lossy, this mode can easily be simulated in exhaustive mode without running into fairness issues.

When using this mode in the Hydro simulator, you must call .test_safety_only() to opt in, because the simulator models dropped messages as indefinitely delayed, which only tests safety properties (not liveness).

Trait Implementations

impl<Tr, S, T: ?Sized> NetworkFor<T> for NetworkingConfig<Tr, S>

where Tr: TransportKind + ?Sized, S: SerKind<T> + ?Sized,

type OrderingGuarantee = <Tr as TransportKind>::OrderingGuarantee

The ordering guarantee provided by this network configuration. When combined with an input stream’s ordering O, the output ordering will be <O as MinOrder<Self::OrderingGuarantee>>::Min.

fn serialize_thunk(is_demux: bool) -> Expr

Generates serialization logic for sending T.

fn deserialize_thunk(tagged: Option<&Type>) -> Expr

Generates deserialization logic for receiving T.

fn is_embedded() -> bool

Whether this network channel leaves serialization to code outside of Hydro (see Embedded). When true, Self::serialize_thunk and Self::deserialize_thunk are never called; the raw element type flows across the channel unserialized.

fn name(&self) -> Option<&str>

Returns the optional name of the network channel.

fn networking_info() -> NetworkingInfo

Returns the NetworkingInfo describing this network channel’s transport and fault model.

impl<Tr, S, T: ?Sized> NetworkFor<T> for NetworkingConfig<Tr, S, String>

where Tr: TransportKind + ?Sized, S: SerKind<T> + ?Sized,

type OrderingGuarantee = <Tr as TransportKind>::OrderingGuarantee

The ordering guarantee provided by this network configuration. When combined with an input stream’s ordering O, the output ordering will be <O as MinOrder<Self::OrderingGuarantee>>::Min.

fn serialize_thunk(is_demux: bool) -> Expr

Generates serialization logic for sending T.

fn deserialize_thunk(tagged: Option<&Type>) -> Expr

Generates deserialization logic for receiving T.

fn is_embedded() -> bool

Whether this network channel leaves serialization to code outside of Hydro (see Embedded). When true, Self::serialize_thunk and Self::deserialize_thunk are never called; the raw element type flows across the channel unserialized.

fn name(&self) -> Option<&str>

Returns the optional name of the network channel.

fn networking_info() -> NetworkingInfo

Returns the NetworkingInfo describing this network channel’s transport and fault model.