mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-08 09:02:18 +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.
79 lines
2.8 KiB
Rust
79 lines
2.8 KiB
Rust
// Copyright 2020 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 async_trait::async_trait;
|
|
use futures::prelude::*;
|
|
use std::io;
|
|
|
|
/// A `Codec` defines the request and response types
|
|
/// for a request-response [`Behaviour`](crate::Behaviour) protocol or
|
|
/// protocol family and how they are encoded / decoded on an I/O stream.
|
|
#[async_trait]
|
|
pub trait Codec {
|
|
/// The type of protocol(s) or protocol versions being negotiated.
|
|
type Protocol: AsRef<str> + Send + Clone;
|
|
/// The type of inbound and outbound requests.
|
|
type Request: Send;
|
|
/// The type of inbound and outbound responses.
|
|
type Response: Send;
|
|
|
|
/// Reads a request from the given I/O stream according to the
|
|
/// negotiated protocol.
|
|
async fn read_request<T>(
|
|
&mut self,
|
|
protocol: &Self::Protocol,
|
|
io: &mut T,
|
|
) -> io::Result<Self::Request>
|
|
where
|
|
T: AsyncRead + Unpin + Send;
|
|
|
|
/// Reads a response from the given I/O stream according to the
|
|
/// negotiated protocol.
|
|
async fn read_response<T>(
|
|
&mut self,
|
|
protocol: &Self::Protocol,
|
|
io: &mut T,
|
|
) -> io::Result<Self::Response>
|
|
where
|
|
T: AsyncRead + Unpin + Send;
|
|
|
|
/// Writes a request to the given I/O stream according to the
|
|
/// negotiated protocol.
|
|
async fn write_request<T>(
|
|
&mut self,
|
|
protocol: &Self::Protocol,
|
|
io: &mut T,
|
|
req: Self::Request,
|
|
) -> io::Result<()>
|
|
where
|
|
T: AsyncWrite + Unpin + Send;
|
|
|
|
/// Writes a response to the given I/O stream according to the
|
|
/// negotiated protocol.
|
|
async fn write_response<T>(
|
|
&mut self,
|
|
protocol: &Self::Protocol,
|
|
io: &mut T,
|
|
res: Self::Response,
|
|
) -> io::Result<()>
|
|
where
|
|
T: AsyncWrite + Unpin + Send;
|
|
}
|