fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-29 18:51:22 +00:00
Code Issues Projects Releases Wiki Activity

feat(core): make the upgrade module an implementation detail

Browse Source 
Resolves: #3748.

Pull-Request: #3915.
This commit is contained in:
Thomas Eizinger 2023-05-15 15:24:18 +02:00 committed by GitHub
parent 5c785b92e7
commit 08f0b5e9c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
core/CHANGELOG.md
View File

@ -23,10 +23,15 @@
- Add `global_only::Transport` that refuses to dial IP addresses from private ranges. - Add `global_only::Transport` that refuses to dial IP addresses from private ranges.
See [PR 3814]. See [PR 3814].
- Remove `upgrade::{apply, apply_inbound, apply_outbound, InboundUpgradeApply, OutboundUpgradeApply}` from public API.
These are implementation details that should not be depended on.
See [PR 3915].
[spec]: https://github.com/libp2p/specs/blob/master/connections/README.md#multistream-select [spec]: https://github.com/libp2p/specs/blob/master/connections/README.md#multistream-select
[PR 3746]: https://github.com/libp2p/rust-libp2p/pull/3746 [PR 3746]: https://github.com/libp2p/rust-libp2p/pull/3746
[PR 3883]: https://github.com/libp2p/rust-libp2p/pull/3883 [PR 3883]: https://github.com/libp2p/rust-libp2p/pull/3883
[PR 3814]: https://github.com/libp2p/rust-libp2p/pull/3814 [PR 3814]: https://github.com/libp2p/rust-libp2p/pull/3814
[PR 3915]: https://github.com/libp2p/rust-libp2p/pull/3915
## 0.39.2 ## 0.39.2

4
core/src/upgrade.rs
View File

@ -66,10 +66,12 @@ mod ready;
mod select; mod select;
mod transfer; mod transfer;
pub(crate) use apply::{
apply, apply_inbound, apply_outbound, InboundUpgradeApply, OutboundUpgradeApply,
};
use futures::future::Future; use futures::future::Future;
pub use self::{ pub use self::{
apply::{apply, apply_inbound, apply_outbound, InboundUpgradeApply, OutboundUpgradeApply},
denied::DeniedUpgrade, denied::DeniedUpgrade,
error::UpgradeError, error::UpgradeError,
pending::PendingUpgrade, pending::PendingUpgrade,

6
core/src/upgrade/apply.rs
View File

@ -29,7 +29,7 @@ pub(crate) use multistream_select::Version;
// TODO: Still needed? // TODO: Still needed?
/// Applies an upgrade to the inbound and outbound direction of a connection or substream. /// Applies an upgrade to the inbound and outbound direction of a connection or substream.
pub fn apply<C, U>( pub(crate) fn apply<C, U>(
conn: C, conn: C,
up: U, up: U,
cp: ConnectedPoint, cp: ConnectedPoint,
@ -48,7 +48,7 @@ where
} }
/// Tries to perform an upgrade on an inbound connection or substream. /// Tries to perform an upgrade on an inbound connection or substream.
pub fn apply_inbound<C, U>(conn: C, up: U) -> InboundUpgradeApply<C, U> pub(crate) fn apply_inbound<C, U>(conn: C, up: U) -> InboundUpgradeApply<C, U>
where where
C: AsyncRead + AsyncWrite + Unpin, C: AsyncRead + AsyncWrite + Unpin,
U: InboundUpgrade<Negotiated<C>>, U: InboundUpgrade<Negotiated<C>>,
@ -62,7 +62,7 @@ where
} }
/// Tries to perform an upgrade on an outbound connection or substream. /// Tries to perform an upgrade on an outbound connection or substream.
pub fn apply_outbound<C, U>(conn: C, up: U, v: Version) -> OutboundUpgradeApply<C, U> pub(crate) fn apply_outbound<C, U>(conn: C, up: U, v: Version) -> OutboundUpgradeApply<C, U>
where where
C: AsyncRead + AsyncWrite + Unpin, C: AsyncRead + AsyncWrite + Unpin,
U: OutboundUpgrade<Negotiated<C>>, U: OutboundUpgrade<Negotiated<C>>,