NetTransportBuilder

Struct NetTransportBuilder 

Source
pub struct NetTransportBuilder<N, T, TP>
where N: NetworkProvider + Clone + 'static, T: TimeProvider + Clone + 'static, TP: TaskProvider + Clone + 'static,
{ /* private fields */ }
Expand description

Builder for NetTransport that eliminates common footguns.

The manual Rc wrapping and set_weak_self() pattern is error-prone: forgetting set_weak_self() causes a runtime panic. This builder handles both automatically.

§Examples

// Standard usage - server or client that needs RPC responses:
let transport = NetTransportBuilder::new(network, time, task)
    .local_address(addr)
    .build_listening()
    .await?;

// Fire-and-forget sender (no listening needed):
let transport = NetTransportBuilder::new(network, time, task)
    .local_address(addr)
    .build();

// With custom peer config:
let transport = NetTransportBuilder::new(network, time, task)
    .local_address(addr)
    .peer_config(config)
    .build_listening()
    .await?;

§Why Build vs Build Listening?

  • build_listening(): For most RPC use cases. Both servers AND clients need this because responses are sent to the client’s listening address.

  • build(): For fire-and-forget messaging where you don’t expect responses. Also useful for testing where you control message flow manually.

Implementations§

Source§

impl<N, T, TP> NetTransportBuilder<N, T, TP>
where N: NetworkProvider + Clone + 'static, T: TimeProvider + Clone + 'static, TP: TaskProvider + Clone + 'static,

Source

pub fn new( network: N, time: T, task_provider: TP, ) -> NetTransportBuilder<N, T, TP>

Create a new builder with the required providers.

§Arguments
  • network - Network provider for TCP connections
  • time - Time provider for timing operations
  • task_provider - Task provider for spawning background tasks
Source

pub fn local_address( self, address: NetworkAddress, ) -> NetTransportBuilder<N, T, TP>

Set the local address for this transport.

This is required before calling build() or build_listening().

§Arguments
  • address - The network address to bind to
Source

pub fn peer_config(self, config: PeerConfig) -> NetTransportBuilder<N, T, TP>

Set custom peer configuration.

If not set, uses PeerConfig::default().

Source

pub fn build(self) -> Rc<NetTransport<N, T, TP>>

Build the transport without starting the listener.

Returns Rc<NetTransport> with set_weak_self() already called. Use this for fire-and-forget messaging or testing.

For RPC (request/response), use build_listening() instead.

§Panics

Panics if local_address() was not called.

Source

pub async fn build_listening( self, ) -> Result<Rc<NetTransport<N, T, TP>>, MessagingError>

Build the transport and start listening for incoming connections.

Returns Rc<NetTransport> with set_weak_self() already called and the listener started.

Use this for typical RPC usage where you need to receive responses. Both servers AND clients need this in a request/response pattern.

§Errors

Returns an error if binding to the local address fails.

§Panics

Panics if local_address() was not called.

Auto Trait Implementations§

§

impl<N, T, TP> Freeze for NetTransportBuilder<N, T, TP>
where N: Freeze, T: Freeze, TP: Freeze,

§

impl<N, T, TP> RefUnwindSafe for NetTransportBuilder<N, T, TP>

§

impl<N, T, TP> Send for NetTransportBuilder<N, T, TP>
where N: Send, T: Send, TP: Send,

§

impl<N, T, TP> Sync for NetTransportBuilder<N, T, TP>
where N: Sync, T: Sync, TP: Sync,

§

impl<N, T, TP> Unpin for NetTransportBuilder<N, T, TP>
where N: Unpin, T: Unpin, TP: Unpin,

§

impl<N, T, TP> UnwindSafe for NetTransportBuilder<N, T, TP>
where N: UnwindSafe, T: UnwindSafe, TP: UnwindSafe,

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more