feat: replace ProtocolName with AsRef<str>

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.
This commit is contained in:
Thomas Eizinger
2023-05-04 05:47:11 +01:00
committed by GitHub
parent 30d0f598ef
commit c93f753018
68 changed files with 539 additions and 561 deletions

View File

@ -52,7 +52,7 @@ pub fn dialer_select_proto<R, I>(
where
R: AsyncRead + AsyncWrite,
I: IntoIterator,
I::Item: AsRef<[u8]>,
I::Item: AsRef<str>,
{
let protocols = protocols.into_iter().peekable();
DialerSelectFuture {
@ -88,7 +88,7 @@ where
// It also makes the implementation considerably easier to write.
R: AsyncRead + AsyncWrite + Unpin,
I: Iterator,
I::Item: AsRef<[u8]>,
I::Item: AsRef<str>,
{
type Output = Result<(I::Item, Negotiated<R>), NegotiationError>;
@ -187,7 +187,7 @@ where
Message::NotAvailable => {
log::debug!(
"Dialer: Received rejection of protocol: {}",
String::from_utf8_lossy(protocol.as_ref())
protocol.as_ref()
);
let protocol = this.protocols.next().ok_or(NegotiationError::Failed)?;
*this.state = State::SendProtocol { io, protocol }