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.

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: the simulator will not actually drop packets—it delays “dropped” messages until the end of the execution, which catches safety bugs but cannot test liveness.

impl<O, F, S: ?Sized> NetworkingConfig<EmbeddedTransport<(), O, F>, S>

pub const fn never_duplicates( self, ) -> NetworkingConfig<EmbeddedTransport<ExactlyOnce, O, F>, S>

Declares that the host’s channel never delivers a message more than once, so the received stream keeps the sent stream’s retries.

pub const fn may_duplicate( self, ) -> NetworkingConfig<EmbeddedTransport<AtLeastOnce, O, F>, S>

Declares that the host’s channel may deliver a message more than once, so the received stream is AtLeastOnce.

impl<R, F, S: ?Sized> NetworkingConfig<EmbeddedTransport<R, (), F>, S>

pub const fn never_reorders( self, ) -> NetworkingConfig<EmbeddedTransport<R, TotalOrder, F>, S>

Declares that the host’s channel delivers each sender’s messages in the order it sent them, so the received stream keeps the sent stream’s order.

pub const fn may_reorder( self, ) -> NetworkingConfig<EmbeddedTransport<R, NoOrder, F>, S>

Declares that the host’s channel may deliver a sender’s messages in a different order than it sent them, so the received stream is NoOrder.

impl<R, O, S: ?Sized> NetworkingConfig<EmbeddedTransport<R, O, ()>, S>

pub const fn never_drops( self, ) -> NetworkingConfig<EmbeddedTransport<R, O, FailStop>, S>

Declares that the host’s channel never drops a message: while it stays live, it delivers every message sent. Like never_reorders and never_duplicates, this holds as long as the channel remains live; if it fails, it delivers nothing more, like TCP.fail_stop().

pub const fn may_drop( self, nondet: NonDet, ) -> NetworkingConfig<EmbeddedTransport<R, O, Lossy>, S>

Declares that the host’s channel may lose messages and keep delivering later ones, like TCP.lossy().

Non-Determinism

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

pub const fn may_delay_forever( self, ) -> NetworkingConfig<EmbeddedTransport<R, O, LossyDelayedForever>, S>

Declares that the host’s channel may never deliver a message, which is treated as indefinitely delayed, like TCP.lossy_delayed_forever(). The received stream is NoOrder.

The Hydro simulator requires .test_safety_only() for this mode.

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

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

Configures the UDP transport to allow messages to be lost.

UDP never guarantees delivery or ordering, so unlike TCP there is no fail_stop policy — messages may always be dropped and the output stream always has NoOrder guarantees.

Non-Determinism

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

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

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

UDP never guarantees delivery or ordering, so unlike TCP there is no fail_stop policy. Unlike Self::lossy, this does not require a NonDet annotation because the output is always lower in the partial order than the ideal stream (dropped messages are modeled as infinite delays). The output stream has 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: the simulator will not actually drop packets—it delays “dropped” messages until the end of the execution, which catches safety bugs but cannot test liveness.

Trait Implementations

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

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

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.

type RetriesGuarantee = <Tr as TransportKind>::RetriesGuarantee

The retry guarantee provided by this network configuration. When combined with an input stream’s retries R, the output retries will be <R as MinRetries<Self::RetriesGuarantee>>::Min.

type ConsistencyGuarantee = <Tr as TransportKind>::ConsistencyGuarantee

The consistency guarantee this network configuration can preserve when the same data is replicated to several recipients (e.g. via Stream::broadcast_closed).

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 (an EMBEDDED channel). 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: ?Sized + TransportKind, S: ?Sized + SerKind<T>,

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.

type RetriesGuarantee = <Tr as TransportKind>::RetriesGuarantee

The retry guarantee provided by this network configuration. When combined with an input stream’s retries R, the output retries will be <R as MinRetries<Self::RetriesGuarantee>>::Min.

type ConsistencyGuarantee = <Tr as TransportKind>::ConsistencyGuarantee

The consistency guarantee this network configuration can preserve when the same data is replicated to several recipients (e.g. via Stream::broadcast_closed).

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 (an EMBEDDED channel). 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.