Skip to main content

SwarmBuilder

rust_ipfs::swarm

Struct SwarmBuilder 

Source 
pub struct SwarmBuilder<Provider, Phase> { /* private fields */ }
Expand description

Build a Swarm by combining an identity, a set of Transports and a NetworkBehaviour.


let swarm = SwarmBuilder::with_new_identity()
    .with_tokio()
    .with_tcp(
        Default::default(),
        (libp2p_tls::Config::new, libp2p_noise::Config::new),
        libp2p_yamux::Config::default,
    )?
    .with_quic()
    .with_other_transport(|_key| DummyTransport::<(PeerId, StreamMuxerBox)>::new())?
    .with_dns()?
    .with_websocket(
        (libp2p_tls::Config::new, libp2p_noise::Config::new),
        libp2p_yamux::Config::default,
    )
    .await?
    .with_relay_client(
        (libp2p_tls::Config::new, libp2p_noise::Config::new),
        libp2p_yamux::Config::default,
    )?
    .with_behaviour(|_key, relay| MyBehaviour { relay })?
    .with_swarm_config(|cfg| {
        // Edit cfg here.
        cfg
    })
    .build();

Implementations§

Source§

impl<T, Provider, R> SwarmBuilder<Provider, BandwidthMetricsPhase<T, R>>

Source

pub fn without_bandwidth_metrics( self, ) -> SwarmBuilder<Provider, BehaviourPhase<T, R>>

Source§

impl<Provider, T> SwarmBuilder<Provider, BandwidthMetricsPhase<T, Behaviour>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair, Behaviour) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl<Provider, T> SwarmBuilder<Provider, BandwidthMetricsPhase<T, NoRelayBehaviour>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl<T, Provider> SwarmBuilder<Provider, BehaviourPhase<T, Behaviour>>

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair, Behaviour) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl<T, Provider> SwarmBuilder<Provider, BehaviourPhase<T, NoRelayBehaviour>>

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl<Provider, T, B> SwarmBuilder<Provider, BuildPhase<T, B>>
where T: AuthenticatedMultiplexedTransport, B: NetworkBehaviour,

Source

pub fn with_connection_timeout( self, connection_timeout: Duration, ) -> SwarmBuilder<Provider, BuildPhase<T, B>>

Timeout of the TransportTimeout wrapping the transport.

Source

pub fn build(self) -> Swarm<B>

Source§

impl<T> SwarmBuilder<Tokio, DnsPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_dns( self, ) -> Result<SwarmBuilder<Tokio, WebsocketPhase<impl AuthenticatedMultiplexedTransport>>, Error>

Source§

impl<T> SwarmBuilder<Tokio, DnsPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_dns_config( self, cfg: ResolverConfig, opts: ResolverOpts, ) -> SwarmBuilder<Tokio, WebsocketPhase<impl AuthenticatedMultiplexedTransport>>

Source§

impl<Provider, T> SwarmBuilder<Provider, DnsPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl SwarmBuilder<NoProviderSpecified, IdentityPhase>

Source

pub fn with_new_identity() -> SwarmBuilder<NoProviderSpecified, ProviderPhase>

Source

pub fn with_existing_identity( keypair: Keypair, ) -> SwarmBuilder<NoProviderSpecified, ProviderPhase>

Source§

impl<Provider, T> SwarmBuilder<Provider, OtherTransportPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_other_transport<Muxer, OtherTransport, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>, <R as TryIntoTransport<OtherTransport>>::Error>
where Muxer: StreamMuxer + Send + 'static, OtherTransport: Transport<Output = (PeerId, Muxer)> + Send + Unpin + 'static, R: TryIntoTransport<OtherTransport>, <OtherTransport as Transport>::Error: Send + Sync + 'static, <OtherTransport as Transport>::Dial: Send, <OtherTransport as Transport>::ListenerUpgrade: Send, <Muxer as StreamMuxer>::Substream: Send, <Muxer as StreamMuxer>::Error: Send + Sync,

Source§

impl<T> SwarmBuilder<Tokio, OtherTransportPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_dns( self, ) -> Result<SwarmBuilder<Tokio, WebsocketPhase<impl AuthenticatedMultiplexedTransport>>, Error>

Source§

impl<T> SwarmBuilder<Tokio, OtherTransportPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_dns_config( self, cfg: ResolverConfig, opts: ResolverOpts, ) -> SwarmBuilder<Tokio, WebsocketPhase<impl AuthenticatedMultiplexedTransport>>

Source§

impl<T, Provider> SwarmBuilder<Provider, OtherTransportPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_relay_client<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Provider, BandwidthMetricsPhase<impl AuthenticatedMultiplexedTransport, Behaviour>>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Error>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<Connection>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade: InboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as InboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as OutboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

See SwarmBuilder::with_relay_client.

Source§

impl<Provider, T> SwarmBuilder<Provider, OtherTransportPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl SwarmBuilder<NoProviderSpecified, ProviderPhase>

Source

pub fn with_tokio(self) -> SwarmBuilder<Tokio, TcpPhase>

Configures the SwarmBuilder to use the Tokio runtime. This method is only available when compiling for non-Wasm targets with the tokio feature enabled

Source§

impl<T> SwarmBuilder<Tokio, QuicPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_quic( self, ) -> SwarmBuilder<Tokio, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>

Source

pub fn with_quic_config( self, constructor: impl FnOnce(Config) -> Config, ) -> SwarmBuilder<Tokio, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>

Source§

impl<Provider, T> SwarmBuilder<Provider, QuicPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_relay_client<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Provider, BandwidthMetricsPhase<impl AuthenticatedMultiplexedTransport, Behaviour>>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Error>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<Connection>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade: InboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as InboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as OutboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

See SwarmBuilder::with_relay_client.

Source

pub fn with_other_transport<Muxer, OtherTransport, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>, <R as TryIntoTransport<OtherTransport>>::Error>
where Muxer: StreamMuxer + Send + 'static, OtherTransport: Transport<Output = (PeerId, Muxer)> + Send + Unpin + 'static, R: TryIntoTransport<OtherTransport>, <OtherTransport as Transport>::Error: Send + Sync + 'static, <OtherTransport as Transport>::Dial: Send, <OtherTransport as Transport>::ListenerUpgrade: Send, <Muxer as StreamMuxer>::Substream: Send, <Muxer as StreamMuxer>::Error: Send + Sync,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl<T> SwarmBuilder<Tokio, QuicPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_dns( self, ) -> Result<SwarmBuilder<Tokio, WebsocketPhase<impl AuthenticatedMultiplexedTransport>>, Error>

Source§

impl<T> SwarmBuilder<Tokio, QuicPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_dns_config( self, cfg: ResolverConfig, opts: ResolverOpts, ) -> SwarmBuilder<Tokio, WebsocketPhase<impl AuthenticatedMultiplexedTransport>>

Source§

impl<T> SwarmBuilder<Tokio, QuicPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub async fn with_websocket<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Tokio, RelayPhase<impl AuthenticatedMultiplexedTransport>>, WebsocketError<<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Error>>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>, <SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade: InboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as InboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as OutboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

See SwarmBuilder::with_websocket.

Source§

impl<Provider, T> SwarmBuilder<Provider, RelayPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_relay_client<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Provider, BandwidthMetricsPhase<impl AuthenticatedMultiplexedTransport, Behaviour>>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Error>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<Connection>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade: InboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as InboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as OutboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

Adds a relay client transport.

Note that both security_upgrade and multiplexer_upgrade take function pointers, i.e. they take the function themselves (without the invocation via ()), not the result of the function invocation. See example below.

let swarm = SwarmBuilder::with_new_identity()
    .with_tokio()
    .with_tcp(
        Default::default(),
        (libp2p_tls::Config::new, libp2p_noise::Config::new),
        libp2p_yamux::Config::default,
    )?
     .with_relay_client(
         (libp2p_tls::Config::new, libp2p_noise::Config::new),
         libp2p_yamux::Config::default,
     )?
Source§

impl<Provider, T> SwarmBuilder<Provider, RelayPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Source§

impl<T, B> SwarmBuilder<Tokio, SwarmPhase<T, B>>

Source

pub fn with_swarm_config( self, constructor: impl FnOnce(Config) -> Config, ) -> SwarmBuilder<Tokio, BuildPhase<T, B>>

Source

pub fn build(self) -> Swarm<B>
where B: NetworkBehaviour, T: AuthenticatedMultiplexedTransport,

Source§

impl SwarmBuilder<Tokio, TcpPhase>

Source

pub fn with_tcp<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, tcp_config: Config, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Tokio, QuicPhase<impl AuthenticatedMultiplexedTransport>>, <SecUpgrade as IntoSecurityUpgrade<TcpStream>>::Error>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<TcpStream>, <SecUpgrade as IntoSecurityUpgrade<TcpStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<TcpStream>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<TcpStream>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<TcpStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<TcpStream>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<TcpStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<TcpStream>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<TcpStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<TcpStream>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

Adds a TCP based transport.

Note that both security_upgrade and multiplexer_upgrade take function pointers, i.e. they take the function themselves (without the invocation via ()), not the result of the function invocation. See example below.

let swarm = SwarmBuilder::with_new_identity()
    .with_tokio()
    .with_tcp(
        Default::default(),
        (libp2p_tls::Config::new, libp2p_noise::Config::new),
        libp2p_yamux::Config::default,
    )?
Source§

impl SwarmBuilder<Tokio, TcpPhase>

Source

pub fn with_quic( self, ) -> SwarmBuilder<Tokio, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>

Source§

impl SwarmBuilder<Tokio, TcpPhase>

Source

pub fn with_quic_config( self, constructor: impl FnOnce(Config) -> Config, ) -> SwarmBuilder<Tokio, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>

Source§

impl<Provider> SwarmBuilder<Provider, TcpPhase>

Source

pub fn with_other_transport<Muxer, OtherTransport, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, OtherTransportPhase<impl AuthenticatedMultiplexedTransport>>, <R as TryIntoTransport<OtherTransport>>::Error>
where Muxer: StreamMuxer + Send + 'static, OtherTransport: Transport<Output = (PeerId, Muxer)> + Send + Unpin + 'static, R: TryIntoTransport<OtherTransport>, <OtherTransport as Transport>::Error: Send + Sync + 'static, <OtherTransport as Transport>::Dial: Send, <OtherTransport as Transport>::ListenerUpgrade: Send, <Muxer as StreamMuxer>::Substream: Send, <Muxer as StreamMuxer>::Error: Send + Sync,

Source§

impl SwarmBuilder<Tokio, TcpPhase>

Source

pub async fn with_websocket<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Tokio, RelayPhase<impl AuthenticatedMultiplexedTransport>>, WebsocketError<<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Error>>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>, <SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade: InboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as InboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as OutboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

See SwarmBuilder::with_websocket.

Source§

impl<T> SwarmBuilder<Tokio, WebsocketPhase<T>>

Adds a websocket client transport.

Note that both security_upgrade and multiplexer_upgrade take function pointers, i.e. they take the function themselves (without the invocation via ()), not the result of the function invocation. See example below.

let swarm = SwarmBuilder::with_new_identity()
    .with_tokio()
    .with_websocket(
        (libp2p_tls::Config::new, libp2p_noise::Config::new),
        libp2p_yamux::Config::default,
    )
    .await?
Source

pub async fn with_websocket<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Tokio, RelayPhase<impl AuthenticatedMultiplexedTransport>>, WebsocketError<<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Error>>
where T: AuthenticatedMultiplexedTransport, SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>, <SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade: InboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as InboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as OutboundConnectionUpgrade<Negotiated<RwStreamSink<BytesConnection<TcpStream>>>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<RwStreamSink<BytesConnection<TcpStream>>>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

Source§

impl<T, Provider> SwarmBuilder<Provider, WebsocketPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_relay_client<SecUpgrade, SecStream, SecError, MuxUpgrade, MuxStream, MuxError>( self, security_upgrade: SecUpgrade, multiplexer_upgrade: MuxUpgrade, ) -> Result<SwarmBuilder<Provider, BandwidthMetricsPhase<impl AuthenticatedMultiplexedTransport, Behaviour>>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Error>
where SecStream: AsyncRead + AsyncWrite + Unpin + Send + 'static, SecError: Error + Send + Sync + 'static, SecUpgrade: IntoSecurityUpgrade<Connection>, <SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade: InboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + OutboundConnectionUpgrade<Negotiated<Connection>, Output = (PeerId, SecStream), Error = SecError> + Clone + Send + 'static, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as InboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as OutboundConnectionUpgrade<Negotiated<Connection>>>::Future: Send, <<<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<SecUpgrade as IntoSecurityUpgrade<Connection>>::Upgrade as UpgradeInfo>::Info: Send, MuxStream: StreamMuxer + Send + 'static, <MuxStream as StreamMuxer>::Substream: Send + 'static, <MuxStream as StreamMuxer>::Error: Send + Sync + 'static, MuxUpgrade: IntoMultiplexerUpgrade<SecStream>, <MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade: InboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + OutboundConnectionUpgrade<Negotiated<SecStream>, Output = MuxStream, Error = MuxError> + Clone + Send + 'static, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as InboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as OutboundConnectionUpgrade<Negotiated<SecStream>>>::Future: Send, MuxError: Error + Send + Sync + 'static, <<<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send, <<MuxUpgrade as IntoMultiplexerUpgrade<SecStream>>::Upgrade as UpgradeInfo>::Info: Send,

See SwarmBuilder::with_relay_client.

Source§

impl<Provider, T> SwarmBuilder<Provider, WebsocketPhase<T>>
where T: AuthenticatedMultiplexedTransport,

Source

pub fn with_behaviour<B, R>( self, constructor: impl FnOnce(&Keypair) -> R, ) -> Result<SwarmBuilder<Provider, SwarmPhase<T, B>>, <R as TryIntoBehaviour<B>>::Error>
where R: TryIntoBehaviour<B>,

Auto Trait Implementations§

§

impl<Provider, Phase> Freeze for SwarmBuilder<Provider, Phase>
where Phase: Freeze,

§

impl<Provider, Phase> RefUnwindSafe for SwarmBuilder<Provider, Phase>
where Phase: RefUnwindSafe, Provider: RefUnwindSafe,

§

impl<Provider, Phase> Send for SwarmBuilder<Provider, Phase>
where Phase: Send, Provider: Send,

§

impl<Provider, Phase> Sync for SwarmBuilder<Provider, Phase>
where Phase: Sync, Provider: Sync,

§

impl<Provider, Phase> Unpin for SwarmBuilder<Provider, Phase>
where Phase: Unpin, Provider: Unpin,

§

impl<Provider, Phase> UnsafeUnpin for SwarmBuilder<Provider, Phase>
where Phase: UnsafeUnpin,

§

impl<Provider, Phase> UnwindSafe for SwarmBuilder<Provider, Phase>
where Phase: UnwindSafe, Provider: 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> TimeoutExt for T

Source§

fn timeout(self, duration: Duration) -> Timeout<Self> ⓘ

Requires a Future or Stream to complete before the specific duration has elapsed. Read more
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
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