Struct Pipe

pub struct Pipe { /* private fields */ }

An NNG communication pipe.

A pipe can be thought of as a single connection and are associated with either the listener or dialer that created them. Therefore, they are automatically associated with a single socket.

Most applications should never concern themselves with individual pipes. However, it is possible to access a pipe when more information about the source of the message is needed or when more control is required over message delivery.

See the NNG documentation for more information.

Implementations

impl Pipe

pub fn dialer(self) -> Option<Dialer>

Returns the dialer associated with this pipe, if any.

pub fn listener(self) -> Option<Listener>

Returns the listener associated with this pipe, if any.

pub fn close(self)

Closes the pipe.

Messages that have been submitted for sending may be flushed or delivered, depending upon the transport and the linger option. Pipe are automatically closed when their creator closes or when the remote peer closes the underlying connection.

Trait Implementations

impl Clone for Pipe

fn clone(&self) -> Pipe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pipe

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

Formats the value using the given formatter.

impl Hash for Pipe

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 Pipe

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

Restrict a value to a certain interval.

impl PartialEq for Pipe

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Pipe

impl Eq for Pipe

impl GetOpt<KeepAlive> for Pipe

impl GetOpt<LocalAddr> for Pipe

impl GetOpt<NoDelay> for Pipe

impl GetOpt<PeerPid> for Pipe

impl GetOpt<RecvMaxSize> for Pipe

impl GetOpt<RemAddr> for Pipe

impl GetOpt<RequestHeaders> for Pipe

impl GetOpt<ResponseHeaders> for Pipe

impl GetOpt<Verified> for Pipe

impl SetOpt<PeerGid> for Pipe

impl SetOpt<PeerUid> for Pipe