mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-06-01 20:21:21 +00:00
c93f753018
Previously, a protocol could be any sequence of bytes as long as it started with `/`. Now, we directly parse a protocol as `String` which enforces it to be valid UTF8. To notify users of this change, we delete the `ProtocolName` trait. The new requirement is that users need to provide a type that implements `AsRef<str>`. We also add a `StreamProtocol` newtype in `libp2p-swarm` which provides an easy way for users to ensure their protocol strings are compliant. The newtype enforces that protocol strings start with `/`. `StreamProtocol` also implements `AsRef<str>`, meaning users can directly use it in their upgrades. `multistream-select` by itself only changes marginally with this patch. The only thing we enforce in the type-system is that protocols must implement `AsRef<str>`. Resolves: #2831. Pull-Request: #3746.
59 lines
2.1 KiB
Rust
59 lines
2.1 KiB
Rust
// Copyright 2017-2018 Parity Technologies (UK) Ltd.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
use crate::upgrade::{InboundUpgrade, OutboundUpgrade, UpgradeInfo};
|
|
use futures::future;
|
|
use std::iter;
|
|
use void::Void;
|
|
|
|
/// Dummy implementation of `UpgradeInfo`/`InboundUpgrade`/`OutboundUpgrade` that doesn't support
|
|
/// any protocol.
|
|
#[derive(Debug, Copy, Clone)]
|
|
pub struct DeniedUpgrade;
|
|
|
|
impl UpgradeInfo for DeniedUpgrade {
|
|
type Info = &'static str;
|
|
type InfoIter = iter::Empty<Self::Info>;
|
|
|
|
fn protocol_info(&self) -> Self::InfoIter {
|
|
iter::empty()
|
|
}
|
|
}
|
|
|
|
impl<C> InboundUpgrade<C> for DeniedUpgrade {
|
|
type Output = Void;
|
|
type Error = Void;
|
|
type Future = future::Pending<Result<Self::Output, Self::Error>>;
|
|
|
|
fn upgrade_inbound(self, _: C, _: Self::Info) -> Self::Future {
|
|
future::pending()
|
|
}
|
|
}
|
|
|
|
impl<C> OutboundUpgrade<C> for DeniedUpgrade {
|
|
type Output = Void;
|
|
type Error = Void;
|
|
type Future = future::Pending<Result<Self::Output, Self::Error>>;
|
|
|
|
fn upgrade_outbound(self, _: C, _: Self::Info) -> Self::Future {
|
|
future::pending()
|
|
}
|
|
}
|