Struct StreamProtocol

pub struct StreamProtocol { /* private fields */ }

Identifies a protocol for a stream.

libp2p nodes use stream protocols to negotiate what to do with a newly opened stream. Stream protocols are string-based and must start with a forward slash: /.

Implementations

impl StreamProtocol

pub const fn new(s: &'static str) -> StreamProtocol

Construct a new protocol from a static string slice.

Panics

This function panics if the protocol does not start with a forward slash: /.

pub fn try_from_owned( protocol: String, ) -> Result<StreamProtocol, InvalidProtocol>

Attempt to construct a protocol from an owned string.

This function will fail if the protocol does not start with a forward slash: /. Where possible, you should use StreamProtocol::new instead to avoid allocations.

Trait Implementations

impl AsRef<str> for StreamProtocol

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StreamProtocol

fn clone(&self) -> StreamProtocol

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamProtocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for StreamProtocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for StreamProtocol

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<&str> for StreamProtocol

fn eq(&self, other: &&str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<StreamProtocol> for &str

fn eq(&self, other: &StreamProtocol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for StreamProtocol

fn eq(&self, other: &StreamProtocol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StreamProtocol