Struct libp2p_yamux::YamuxConfig

source · [−]

pub struct YamuxConfig { /* private fields */ }

Expand description

The yamux configuration.

Implementations

source

impl YamuxConfig

source

pub fn client() -> Self

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

source

pub fn server() -> Self

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

source

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

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

source

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

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

source

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

Sets the maximum number of concurrent substreams.

source

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

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

source

pub fn into_local(self) -> YamuxLocalConfig

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

Trait Implementations

source

impl Clone for YamuxConfig

source

fn clone(&self) -> YamuxConfig

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

source

impl Default for YamuxConfig

source

fn default() -> Self

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

source

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

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.

source

fn upgrade_inbound(self, io: C, _: Self::Info) -> Self::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

source

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

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.

source

fn upgrade_outbound(self, io: C, _: Self::Info) -> Self::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

source

impl UpgradeInfo for YamuxConfig

type Info = &'static [u8 ]

Opaque type representing a negotiable protocol.

type InfoIter = Once<Self::Info>

Iterator returned by protocol_info.

source

fn protocol_info(&self) -> Self::InfoIter

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

Auto Trait Implementations

impl RefUnwindSafe for YamuxConfig

impl Send for YamuxConfig

impl Sync for YamuxConfig

impl Unpin for YamuxConfig

impl UnwindSafe for YamuxConfig

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,

source

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.

source

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.

source

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

source

impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,

source

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.

source

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct libp2p_yamux::YamuxConfig

Implementations

impl YamuxConfig

pub fn client() -> Self

pub fn server() -> Self

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

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

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

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

pub fn into_local(self) -> YamuxLocalConfig

Trait Implementations

impl Clone for YamuxConfig

fn clone(&self) -> YamuxConfig

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

impl Default for YamuxConfig

fn default() -> Self

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

type Output = Yamux<Incoming<C>>

type Error = Error

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

fn upgrade_inbound(self, io: C, _: Self::Info) -> Self::Future

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

type Output = Yamux<Incoming<C>>

type Error = Error

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

fn upgrade_outbound(self, io: C, _: Self::Info) -> Self::Future

impl UpgradeInfo for YamuxConfig

type Info = &'static [u8]

type InfoIter = Once<Self::Info>

fn protocol_info(&self) -> Self::InfoIter

Auto Trait Implementations

impl RefUnwindSafe for YamuxConfig

impl Send for YamuxConfig

impl Sync for YamuxConfig

impl Unpin for YamuxConfig

impl UnwindSafe for YamuxConfig

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<C, U> InboundUpgradeExt<C> for U where U: InboundUpgrade<C>,

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where F: FnOnce(Self::Output) -> T,

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where F: FnOnce(Self::Error) -> T,

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

pub fn into(self) -> U

impl<C, U> OutboundUpgradeExt<C> for U where U: OutboundUpgrade<C>,

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where F: FnOnce(Self::Output) -> T,

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where F: FnOnce(Self::Error) -> T,

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

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

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

type Info = &'static [u8 ]

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

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

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

impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

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

impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

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

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

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

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