Struct libp2p :: yamux :: Config Copy item path

impl Config

pub fn client() -> Config

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

pub fn server() -> Config

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 Config

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

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

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

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

Sets the maximum number of concurrent substreams.

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

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

Trait Implementations§

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Config

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

Formats the value using the given formatter. Read more

impl Default for Config

fn default() -> Config

Returns the “default value” for a type. Read more

impl<C> InboundUpgrade<C> for Config
where C: AsyncRead + AsyncWrite + Send + Unpin + 'static,

type Output = Muxer<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.

fn upgrade_inbound( self, io: C, _: <Config as UpgradeInfo>::Info, ) -> <Config as InboundUpgrade<C>>::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

impl<C> OutboundUpgrade<C> for Config
where C: AsyncRead + AsyncWrite + Send + Unpin + 'static,

type Output = Muxer<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.

fn upgrade_outbound( self, io: C, _: <Config as UpgradeInfo>::Info, ) -> <Config as OutboundUpgrade<C>>::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

impl UpgradeInfo for Config

type Info = &'static str

Opaque type representing a negotiable protocol.

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

Iterator returned by protocol_info.

fn protocol_info(&self) -> <Config as UpgradeInfo>::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.

Auto Trait Implementations§

impl UnwindSafe for Config

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<U, T> InboundConnectionUpgrade<T> for U
where U: InboundUpgrade<T>,

type Output = >::Output

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

type Error = >::Error

Possible error during the handshake.

type Future = >::Future

Future that performs the handshake with the remote.

fn upgrade_inbound( self, socket: T, info: ::Info, ) -> >::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

impl<T, TInfo> InboundUpgradeSend for T
where T: InboundUpgrade<Stream, Info = TInfo> + UpgradeInfoSend<Info = TInfo>, TInfo: AsRef<str> + Clone + Send + 'static, <T as InboundUpgrade<Stream>>::Output: Send + 'static, <T as InboundUpgrade<Stream>>::Error: Send + 'static, <T as InboundUpgrade<Stream>>::Future: Send + 'static,

type Output = <T as InboundUpgrade<Stream>>::Output

Equivalent to InboundUpgrade::Output.

type Error = <T as InboundUpgrade<Stream>>::Error

Equivalent to InboundUpgrade::Error.

type Future = <T as InboundUpgrade<Stream>>::Future

Equivalent to InboundUpgrade::Future.

fn upgrade_inbound( self, socket: Stream, info: TInfo, ) -> <T as InboundUpgradeSend>::Future

Equivalent to InboundUpgrade::upgrade_inbound.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more