Skip to main content

NetTransportBuilder

Struct NetTransportBuilder 

Source
pub struct NetTransportBuilder<P, C = JsonCodec>
where P: Providers, C: MessageCodec,
{ /* private fields */ }
Expand description

Builder for NetTransport that eliminates common footguns.

The manual Arc 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(providers)
    .local_address(addr)
    .build_listening()
    .await?;

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

// With custom peer config:
let transport = NetTransportBuilder::new(providers)
    .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<P> NetTransportBuilder<P>
where P: Providers,

Source

pub fn new(providers: P) -> NetTransportBuilder<P>

Create a new builder with the providers bundle.

Uses JsonCodec by default. Call .codec() to use a different codec.

§Arguments
  • providers - Providers bundle for network, time, task, and random
Source§

impl NetTransportBuilder<TokioProviders>

Source

pub fn tokio() -> NetTransportBuilder<TokioProviders>

Create a builder backed by the production TokioProviders bundle.

Shorthand for NetTransportBuilder::new(TokioProviders::new()) — the usual production entry point.

Source§

impl<P, C> NetTransportBuilder<P, C>
where P: Providers + Send + Sync, C: MessageCodec,

Source

pub fn codec<NewC>(self, codec: NewC) -> NetTransportBuilder<P, NewC>
where NewC: MessageCodec,

Set the message codec for this transport.

The codec is used for all serialization/deserialization in RPC handlers and client endpoints created from this transport.

Source

pub fn local_address(self, address: NetworkAddress) -> NetTransportBuilder<P, C>

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<P, C>

Set custom peer configuration.

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

Source

pub fn build(self) -> Result<Arc<NetTransport<P, C>>, MessagingError>

Build the transport without starting the listener.

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

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

§Errors

Returns MessagingError::MissingLocalAddress if local_address() was not called.

Source

pub async fn build_listening( self, ) -> Result<Arc<NetTransport<P, C>>, MessagingError>

Build the transport and start listening for incoming connections.

Returns Arc<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 MessagingError::MissingLocalAddress if local_address() was not called, or a network error if binding to the local address fails.

Auto Trait Implementations§

§

impl<P, C> Freeze for NetTransportBuilder<P, C>
where P: Freeze, C: Freeze,

§

impl<P, C> RefUnwindSafe for NetTransportBuilder<P, C>

§

impl<P, C> Send for NetTransportBuilder<P, C>

§

impl<P, C> Sync for NetTransportBuilder<P, C>

§

impl<P, C> Unpin for NetTransportBuilder<P, C>
where P: Unpin, C: Unpin,

§

impl<P, C> UnsafeUnpin for NetTransportBuilder<P, C>
where P: UnsafeUnpin, C: UnsafeUnpin,

§

impl<P, C> UnwindSafe for NetTransportBuilder<P, C>
where P: UnwindSafe, C: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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