fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-24 15:21:33 +00:00
Code Issues Projects Releases Wiki Activity

refactor(core)!: remove EitherTransport (#3338)

Browse Source 
We don't need to define our own type here, we can simply implement `Transport` on `either::Either`.
This commit is contained in:
Thomas Eizinger
2023-01-18 11:58:09 +11:00
committed by GitHub
parent f4fed3880b
commit c18939f8dc
3 changed files with 21 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
core/CHANGELOG.md
View File

@ -14,12 +14,15 @@
- Remove `EitherError` in favor of `either::Either`. See [PR 3337]. - Remove `EitherError` in favor of `either::Either`. See [PR 3337].
- Remove `EitherTransport` in favor of implementing `Transport` on `either::Either`. See [PR 3338].
[PR 3031]: https://github.com/libp2p/rust-libp2p/pull/3031 [PR 3031]: https://github.com/libp2p/rust-libp2p/pull/3031
[PR 3058]: https://github.com/libp2p/rust-libp2p/pull/3058 [PR 3058]: https://github.com/libp2p/rust-libp2p/pull/3058
[PR 3097]: https://github.com/libp2p/rust-libp2p/pull/3097 [PR 3097]: https://github.com/libp2p/rust-libp2p/pull/3097
[PR 3090]: https://github.com/libp2p/rust-libp2p/pull/3090 [PR 3090]: https://github.com/libp2p/rust-libp2p/pull/3090
[PR 2972]: https://github.com/libp2p/rust-libp2p/pull/2972 [PR 2972]: https://github.com/libp2p/rust-libp2p/pull/2972
[PR 3337]: https://github.com/libp2p/rust-libp2p/pull/3337 [PR 3337]: https://github.com/libp2p/rust-libp2p/pull/3337
[PR 3338]: https://github.com/libp2p/rust-libp2p/pull/3338
# 0.37.0 # 0.37.0

35
core/src/either.rs
View File

@ -293,15 +293,8 @@ impl<A: ProtocolName, B: ProtocolName> ProtocolName for EitherName<A, B> {
} }
} }
} }
#[pin_project(project = EitherTransportProj)]
#[derive(Debug)]
#[must_use = "transports do nothing unless polled"]
pub enum EitherTransport<A, B> {
Left(#[pin] A),
Right(#[pin] B),
}
impl<A, B> Transport for EitherTransport<A, B> impl<A, B> Transport for Either<A, B>
where where
B: Transport, B: Transport,
A: Transport, A: Transport,
@ -315,14 +308,14 @@ where
self: Pin<&mut Self>, self: Pin<&mut Self>,
cx: &mut Context<'_>, cx: &mut Context<'_>,
) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>> { ) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>> {
match self.project() { match self.as_pin_mut() {
EitherTransportProj::Left(a) => match a.poll(cx) { Either::Left(a) => match a.poll(cx) {
Poll::Pending => Poll::Pending, Poll::Pending => Poll::Pending,
Poll::Ready(event) => { Poll::Ready(event) => {
Poll::Ready(event.map_upgrade(EitherFuture::First).map_err(Either::Left)) Poll::Ready(event.map_upgrade(EitherFuture::First).map_err(Either::Left))
} }
}, },
EitherTransportProj::Right(b) => match b.poll(cx) { Either::Right(b) => match b.poll(cx) {
Poll::Pending => Poll::Pending, Poll::Pending => Poll::Pending,
Poll::Ready(event) => Poll::Ready( Poll::Ready(event) => Poll::Ready(
event event
@ -335,19 +328,19 @@ where
fn remove_listener(&mut self, id: ListenerId) -> bool { fn remove_listener(&mut self, id: ListenerId) -> bool {
match self { match self {
EitherTransport::Left(t) => t.remove_listener(id), Either::Left(t) => t.remove_listener(id),
EitherTransport::Right(t) => t.remove_listener(id), Either::Right(t) => t.remove_listener(id),
} }
} }
fn listen_on(&mut self, addr: Multiaddr) -> Result<ListenerId, TransportError<Self::Error>> { fn listen_on(&mut self, addr: Multiaddr) -> Result<ListenerId, TransportError<Self::Error>> {
use TransportError::*; use TransportError::*;
match self { match self {
EitherTransport::Left(a) => a.listen_on(addr).map_err(|e| match e { Either::Left(a) => a.listen_on(addr).map_err(|e| match e {
MultiaddrNotSupported(addr) => MultiaddrNotSupported(addr), MultiaddrNotSupported(addr) => MultiaddrNotSupported(addr),
Other(err) => Other(Either::Left(err)), Other(err) => Other(Either::Left(err)),
}), }),
EitherTransport::Right(b) => b.listen_on(addr).map_err(|e| match e { Either::Right(b) => b.listen_on(addr).map_err(|e| match e {
MultiaddrNotSupported(addr) => MultiaddrNotSupported(addr), MultiaddrNotSupported(addr) => MultiaddrNotSupported(addr),
Other(err) => Other(Either::Right(err)), Other(err) => Other(Either::Right(err)),
}), }),
@ -357,12 +350,12 @@ where
fn dial(&mut self, addr: Multiaddr) -> Result<Self::Dial, TransportError<Self::Error>> { fn dial(&mut self, addr: Multiaddr) -> Result<Self::Dial, TransportError<Self::Error>> {
use TransportError::*; use TransportError::*;
match self { match self {
EitherTransport::Left(a) => match a.dial(addr) { Either::Left(a) => match a.dial(addr) {
Ok(connec) => Ok(EitherFuture::First(connec)), Ok(connec) => Ok(EitherFuture::First(connec)),
Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)), Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)),
Err(Other(err)) => Err(Other(Either::Left(err))), Err(Other(err)) => Err(Other(Either::Left(err))),
}, },
EitherTransport::Right(b) => match b.dial(addr) { Either::Right(b) => match b.dial(addr) {
Ok(connec) => Ok(EitherFuture::Second(connec)), Ok(connec) => Ok(EitherFuture::Second(connec)),
Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)), Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)),
Err(Other(err)) => Err(Other(Either::Right(err))), Err(Other(err)) => Err(Other(Either::Right(err))),
@ -379,12 +372,12 @@ where
{ {
use TransportError::*; use TransportError::*;
match self { match self {
EitherTransport::Left(a) => match a.dial_as_listener(addr) { Either::Left(a) => match a.dial_as_listener(addr) {
Ok(connec) => Ok(EitherFuture::First(connec)), Ok(connec) => Ok(EitherFuture::First(connec)),
Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)), Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)),
Err(Other(err)) => Err(Other(Either::Left(err))), Err(Other(err)) => Err(Other(Either::Left(err))),
}, },
EitherTransport::Right(b) => match b.dial_as_listener(addr) { Either::Right(b) => match b.dial_as_listener(addr) {
Ok(connec) => Ok(EitherFuture::Second(connec)), Ok(connec) => Ok(EitherFuture::Second(connec)),
Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)), Err(MultiaddrNotSupported(addr)) => Err(MultiaddrNotSupported(addr)),
Err(Other(err)) => Err(Other(Either::Right(err))), Err(Other(err)) => Err(Other(Either::Right(err))),
@ -394,8 +387,8 @@ where
fn address_translation(&self, server: &Multiaddr, observed: &Multiaddr) -> Option<Multiaddr> { fn address_translation(&self, server: &Multiaddr, observed: &Multiaddr) -> Option<Multiaddr> {
match self { match self {
EitherTransport::Left(a) => a.address_translation(server, observed), Either::Left(a) => a.address_translation(server, observed),
EitherTransport::Right(b) => b.address_translation(server, observed), Either::Right(b) => b.address_translation(server, observed),
} }
} }
} }

9
examples/ipfs-private.rs
View File

@ -32,11 +32,10 @@
//! You can ping this node, or use pubsub (gossipsub) on the topic "chat". For this //! You can ping this node, or use pubsub (gossipsub) on the topic "chat". For this
//! to work, the ipfs node needs to be configured to use gossipsub. //! to work, the ipfs node needs to be configured to use gossipsub.
use async_std::io; use async_std::io;
use either::Either;
use futures::{prelude::*, select}; use futures::{prelude::*, select};
use libp2p::{ use libp2p::{
core::{ core::{muxing::StreamMuxerBox, transport, transport::upgrade::Version},
either::EitherTransport, muxing::StreamMuxerBox, transport, transport::upgrade::Version,
},
gossipsub::{self, Gossipsub, GossipsubConfigBuilder, GossipsubEvent, MessageAuthenticity}, gossipsub::{self, Gossipsub, GossipsubConfigBuilder, GossipsubEvent, MessageAuthenticity},
identify, identity, identify, identity,
multiaddr::Protocol, multiaddr::Protocol,
@ -59,10 +58,10 @@ pub fn build_transport(
let base_transport = tcp::async_io::Transport::new(tcp::Config::default().nodelay(true)); let base_transport = tcp::async_io::Transport::new(tcp::Config::default().nodelay(true));
let maybe_encrypted = match psk { let maybe_encrypted = match psk {
Some(psk) => EitherTransport::Left( Some(psk) => Either::Left(
base_transport.and_then(move |socket, _| PnetConfig::new(psk).handshake(socket)), base_transport.and_then(move |socket, _| PnetConfig::new(psk).handshake(socket)),
), ),
None => EitherTransport::Right(base_transport), None => Either::Right(base_transport),
}; };
maybe_encrypted maybe_encrypted
.upgrade(Version::V1) .upgrade(Version::V1)