[][src]Struct libp2p::yamux::Config

pub struct Config(_);

The yamux configuration.

Methods

impl Config[src]

pub fn new(cfg: Config) -> Config[src]

pub fn local(self) -> LocalConfig[src]

Turn this into a [LocalConfig] for use with upgrades of Send resources.

Methods from Deref<Target = Config>

pub fn set_receive_window(&mut self, n: u32) -> &mut Config

Set the receive window (must be >= 256 KiB).

Panics

If the given receive window is < 256 KiB.

pub fn set_max_buffer_size(&mut self, n: usize) -> &mut Config

Set the max. buffer size per stream.

pub fn set_max_num_streams(&mut self, n: usize) -> &mut Config

Set the max. number of streams.

pub fn set_window_update_mode(&mut self, m: WindowUpdateMode) -> &mut Config

Set the window update mode to use.

pub fn set_read_after_close(&mut self, b: bool) -> &mut Config

Allow or disallow streams to read from buffered data after the connection has been closed.

pub fn set_lazy_open(&mut self, b: bool) -> &mut Config

Enable or disable the sending of an initial window update frame when opening outbound streams.

When enabled, opening a new outbound stream will not result in an immediate send of a frame, instead the first outbound data frame will be marked as opening a stream.

When disabled (the current default), opening a new outbound stream will result in a window update frame being sent immediately to the remote. This allows opening a stream with a custom receive window size (cf. [Config::set_receive_window]) which the remote can directly make use of.

Trait Implementations

impl Clone for Config[src]

impl Default for Config[src]

impl Deref for Config[src]

type Target = Config

The resulting type after dereferencing.

impl DerefMut for Config[src]

impl<C> InboundUpgrade<C> for Config 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<<Config as InboundUpgrade<C>>::Output, <Config as InboundUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

impl<C> OutboundUpgrade<C> for Config 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<<Config as OutboundUpgrade<C>>::Output, <Config as OutboundUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

impl UpgradeInfo for Config[src]

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

type InfoIter = Once<<Config as UpgradeInfo>::Info>

Iterator returned by protocol_info.

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

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> Clear for T where
    T: InitializableFromZeroed + ?Sized

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

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

impl<T, TInfo> InboundUpgradeSend for T where
    T: InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>, Info = TInfo> + UpgradeInfoSend<Info = TInfo>,
    TInfo: ProtocolName + Clone + Send + 'static,
    <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Output: Send,
    <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Output: 'static,
    <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Error: Send,
    <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Error: 'static,
    <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Future: Send,
    <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Future: 'static, 
[src]

type Output = <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Output

Equivalent to InboundUpgrade::Output.

type Error = <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Error

Equivalent to InboundUpgrade::Error.

type Future = <T as InboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Future

Equivalent to InboundUpgrade::Future.

impl<T> InitializableFromZeroed for T where
    T: Default

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, TInfo> OutboundUpgradeSend for T where
    T: OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>, Info = TInfo> + UpgradeInfoSend<Info = TInfo>,
    TInfo: ProtocolName + Clone + Send + 'static,
    <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Output: Send,
    <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Output: 'static,
    <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Error: Send,
    <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Error: 'static,
    <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Future: Send,
    <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Future: 'static, 
[src]

type Output = <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Output

Equivalent to OutboundUpgrade::Output.

type Error = <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Error

Equivalent to OutboundUpgrade::Error.

type Future = <T as OutboundUpgrade<Compat01As03<Negotiated<Compat<SubstreamRef<Arc<StreamMuxerBox>>>>>>>::Future

Equivalent to OutboundUpgrade::Future.

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<T> UpgradeInfoSend for T where
    T: UpgradeInfo + Send + 'static,
    <T as UpgradeInfo>::Info: Send,
    <T as UpgradeInfo>::Info: 'static,
    <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send,
    <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: 'static, 
[src]

type Info = <T as UpgradeInfo>::Info

Equivalent to UpgradeInfo::Info.

type InfoIter = <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter

Equivalent to UpgradeInfo::InfoIter.

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