Struct libp2p_yamux::YamuxConfig[][src]

pub struct YamuxConfig { /* fields omitted */ }

The yamux configuration.

Implementations

impl YamuxConfig[src]

pub fn client() -> Self[src]

Creates a new YamuxConfig in client mode, regardless of whether it will be used for an inbound or outbound upgrade.

pub fn server() -> Self[src]

Creates a new YamuxConfig in server mode, regardless of whether it will be used for an inbound or outbound upgrade.

pub fn set_receive_window_size(&mut self, num_bytes: u32) -> &mut Self[src]

Sets the size (in bytes) of the receive window per substream.

pub fn set_max_buffer_size(&mut self, num_bytes: usize) -> &mut Self[src]

Sets the maximum size (in bytes) of the receive buffer per substream.

pub fn set_max_num_streams(&mut self, num_streams: usize) -> &mut Self[src]

Sets the maximum number of concurrent substreams.

pub fn set_window_update_mode(&mut self, mode: WindowUpdateMode) -> &mut Self[src]

Sets the window update mode that determines when the remote is given new credit for sending more data.

pub fn into_local(self) -> YamuxLocalConfig[src]

Converts the config into a YamuxLocalConfig for use with upgrades of I/O streams that are Send.

Trait Implementations

impl Clone for YamuxConfig[src]

impl Default for YamuxConfig[src]

impl<C> InboundUpgrade<C> for YamuxConfig where
    C: AsyncRead + AsyncWrite + Send + Unpin + 'static, 
[src]

type Output = Yamux<Incoming<C>>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Error

Possible error during the handshake.

type Future = Ready<Result<Self::Output, Self::Error>>

Future that performs the handshake with the remote.

impl<C> OutboundUpgrade<C> for YamuxConfig where
    C: AsyncRead + AsyncWrite + Send + Unpin + 'static, 
[src]

type Output = Yamux<Incoming<C>>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Error

Possible error during the handshake.

type Future = Ready<Result<Self::Output, Self::Error>>

Future that performs the handshake with the remote.

impl UpgradeInfo for YamuxConfig[src]

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<Self::Info>

Iterator returned by protocol_info.

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<C, U> InboundUpgradeExt<C> for U where
    U: InboundUpgrade<C>, 
[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<C, U> OutboundUpgradeExt<C> for U where
    U: OutboundUpgrade<C>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,