Struct Config

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

Available on crate feature yamux only.

Expand description

The yamux configuration.

Implementations§

impl Config

pub fn client() -> Config

👎Deprecated: Will be removed with the next breaking release.

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

pub fn server() -> Config

👎Deprecated: Will be removed with the next breaking release.

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

👎Deprecated: Will be replaced in the next breaking release with a connection receive window size limit.

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

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

👎Deprecated: Will be removed with the next breaking release.

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

👎Deprecated: WindowUpdate::OnRead is the default. WindowUpdate::OnReceive breaks backpressure, is thus not recommended, and will be removed in the next breaking release. Thus this method becomes obsolete and will be removed with the next breaking release.

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> InboundConnectionUpgrade<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 InboundConnectionUpgrade<C>>::Output, <Config as InboundConnectionUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

fn upgrade_inbound( self, io: C, _: <Config as UpgradeInfo>::Info, ) -> <Config as InboundConnectionUpgrade<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> OutboundConnectionUpgrade<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 OutboundConnectionUpgrade<C>>::Output, <Config as OutboundConnectionUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

fn upgrade_outbound( self, io: C, _: <Config as UpgradeInfo>::Info, ) -> <Config as OutboundConnectionUpgrade<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 Freeze for Config

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,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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,

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<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<U> 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

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UpgradeInfoSend for T
where T: UpgradeInfo + Send + 'static, <T as UpgradeInfo>::Info: Send + 'static, <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send + 'static,

type Info = <T as UpgradeInfo>::Info

Equivalent to UpgradeInfo::Info.

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

Equivalent to UpgradeInfo::InfoIter.

fn protocol_info(&self) -> <T as UpgradeInfoSend>::InfoIter

Equivalent to UpgradeInfo::protocol_info.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more