fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-27 08:41:36 +00:00
Code Issues Projects Releases Wiki Activity

feat(core): deprecate upgrade::from_fn

Browse Source 
This functionality isn't needed anywhere in `rust-libp2p` so we can deprecate and later remove it and thus reduce our API surface. Users relying on this function can vendor it.

Pull-Request: #3747.
This commit is contained in:
Thomas Eizinger
2023-04-20 00:07:42 +02:00
committed by GitHub
parent 5df321d8b9
commit 0fe9791829
5 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
core/src/upgrade.rs
View File

@ -71,11 +71,12 @@ mod transfer;
use futures::future::Future;
#[allow(deprecated)]
pub use self::from_fn::{from_fn, FromFnUpgrade};
pub use self::{
apply::{apply, apply_inbound, apply_outbound, InboundUpgradeApply, OutboundUpgradeApply},
denied::DeniedUpgrade,
error::UpgradeError,
from_fn::{from_fn, FromFnUpgrade},
map::{MapInboundUpgrade, MapInboundUpgradeErr, MapOutboundUpgrade, MapOutboundUpgradeErr},
optional::OptionalUpgrade,
pending::PendingUpgrade,

11
core/src/upgrade/from_fn.rs
View File

@ -35,6 +35,7 @@ use std::iter;
/// # use libp2p_core::{upgrade, Negotiated};
/// # use std::io;
/// # use futures::AsyncWriteExt;
/// # #[allow(deprecated)]
/// let _transport = MemoryTransport::default()
/// .and_then(move |out, cp| {
/// upgrade::apply(out, upgrade::from_fn("/foo/1", move |mut sock: Negotiated<Channel<Vec<u8>>>, endpoint| async move {
@ -52,6 +53,10 @@ use std::iter;
/// });
/// ```
///
#[deprecated(
note = "`from_fn` upgrade will be removed without replacement as it is not used within `rust-libp2p`."
)]
#[allow(deprecated)]
pub fn from_fn<P, F, C, Fut, Out, Err>(protocol_name: P, fun: F) -> FromFnUpgrade<P, F>
where
// Note: these bounds are there in order to help the compiler infer types
@ -66,11 +71,15 @@ where
///
/// The upgrade consists in calling the function passed when creating this struct.
#[derive(Debug, Clone)]
#[deprecated(
note = "`from_fn` upgrade will be removed without replacement as it is not used within `rust-libp2p`."
)]
pub struct FromFnUpgrade<P, F> {
protocol_name: P,
fun: F,
}
#[allow(deprecated)]
impl<P, F> UpgradeInfo for FromFnUpgrade<P, F>
where
P: ProtocolName + Clone,
@ -83,6 +92,7 @@ where
}
}
#[allow(deprecated)]
impl<C, P, F, Fut, Err, Out> InboundUpgrade<C> for FromFnUpgrade<P, F>
where
P: ProtocolName + Clone,
@ -98,6 +108,7 @@ where
}
}
#[allow(deprecated)]
impl<C, P, F, Fut, Err, Out> OutboundUpgrade<C> for FromFnUpgrade<P, F>
where
P: ProtocolName + Clone,