Struct TransportId

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

Identify a type of Transport.

If this crate is compiled with the pt-client feature, this type can support pluggable transports; otherwise, only the built-in transport type is supported.

This can be displayed as, or parsed from, a string. "-" is used to indicate the builtin transport, and "" and "bridge" and "<none>" are also recognised for that.

Implementations

impl TransportId

pub fn new_builtin() -> Self

Return a new TransportId referencing the builtin transport

This is equivalent to the Default impl.

pub fn new_pluggable(pt: PtTransportName) -> Self

Available on crate feature pt-client only.

Return a new TransportId referencing a pluggable transport

This is equivalent to the From<PtTransportName> impl.

pub fn is_builtin(&self) -> bool

Return true if this is the built-in transport.

pub fn as_pluggable(&self) -> Option<&PtTransportName>

Available on crate feature pt-client only.

Returns the pluggable transport name

Or None if self doesn’t specify a pluggable transport (e.g. if it specifies the builtin transport).

pub fn into_pluggable(self) -> Option<PtTransportName>

Available on crate feature pt-client only.

Consumes this TransportId and returns the pluggable transport name

Or None if self doesn’t specify a pluggable transport (e.g. if it specifies the builtin transport).

Trait Implementations

impl Clone for TransportId

fn clone(&self) -> TransportId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransportId

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

Formats the value using the given formatter.

impl Default for TransportId

fn default() -> TransportId

Returns the “default value” for a type.

impl Display for TransportId

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

Formats the value using the given formatter.

impl From<PtTransportName> for TransportId

Available on crate feature pt-client only.

fn from(name: PtTransportName) -> Self

Converts to this type from the input type.

impl FromStr for TransportId

type Err = TransportIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TransportId

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 PartialEq for TransportId

fn eq(&self, other: &TransportId) -> 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 TransportId

impl StructuralPartialEq for TransportId