Struct ockam_core::ProtocolId

pub struct ProtocolId(/* private fields */);

A user-defined protocol identifier.

When creating workers that should asynchronously speak different protocols, this identifier can be used to switch message parsing between delegated workers, each responsible for only one protocol.

TODO @deprecated supplanted by the new metadata message types in ockam::OckamMessage

Implementations

impl ProtocolId

pub fn none() -> Self

Create a None protocol Id (with left pad).

pub fn from_str(s: &str) -> Self

Use the first 8 bytes of a string as the protocol ID.

pub fn as_str(&self) -> &str

Return the protocol as a &str.

Trait Implementations

impl Clone for ProtocolId

fn clone(&self) -> ProtocolId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProtocolId

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

Formats the value using the given formatter.

impl From<&'static str> for ProtocolId

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl Hash for ProtocolId

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

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 Ord for ProtocolId

fn cmp(&self, other: &ProtocolId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ProtocolId

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ProtocolId

fn partial_cmp(&self, other: &ProtocolId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ProtocolId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProtocolId

impl StructuralPartialEq for ProtocolId