Struct smoldot_light::platform::with_buffers::WithBuffers

source · 
pub struct WithBuffers<TSocketFut, TSocket, TNow> { /* private fields */ }
Expand description

Holds an implementation of AsyncRead and AsyncWrite, alongside with a read buffer and a write buffer.

Implementations§

source§

impl<TSocketFut, TSocket, TNow> WithBuffers<TSocketFut, TSocket, TNow>
where TNow: Clone + Ord,

source

pub fn new(socket: TSocketFut) -> WithBuffers<TSocketFut, TSocket, TNow>

Initializes a new WithBuffers with the given socket-yielding future.

source

pub fn read_write_access( self: Pin<&mut WithBuffers<TSocketFut, TSocket, TNow>>, now: TNow, ) -> Result<ReadWriteAccess<'_, TNow>, &Error>

Returns an object that implements Deref<Target = ReadWrite>. This object can be used to push or pull data to/from the socket.

Note: The parameter requires Self to be pinned for consistency with WithBuffers::wait_read_write_again.

source§

impl<TSocketFut, TSocket, TNow> WithBuffers<TSocketFut, TSocket, TNow>
where TSocket: AsyncRead + AsyncWrite, TSocketFut: Future<Output = Result<TSocket, Error>>, TNow: Clone + Ord,

source

pub async fn wait_read_write_again<F>( self: Pin<&mut WithBuffers<TSocketFut, TSocket, TNow>>, timer_builder: impl FnOnce(TNow) -> F, )
where F: Future<Output = ()>,

Waits until WithBuffers::read_write_access should be called again.

Returns immediately if WithBuffers::read_write_access has never been called.

Returns if an error happens on the socket. If an error happened in the past on the socket, the future never yields.

Trait Implementations§

source§

impl<TSocketFut, TSocket, TNow> Debug for WithBuffers<TSocketFut, TSocket, TNow>
where TSocket: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<'pin, TSocketFut, TSocket, TNow> Unpin for WithBuffers<TSocketFut, TSocket, TNow>
where <PinnedFieldsOfHelperStruct<__WithBuffers<'pin, TSocketFut, TSocket, TNow>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,

Auto Trait Implementations§

§

impl<TSocketFut, TSocket, TNow> Freeze for WithBuffers<TSocketFut, TSocket, TNow>
where TSocketFut: Freeze, TSocket: Freeze, TNow: Freeze,

§

impl<TSocketFut, TSocket, TNow> !RefUnwindSafe for WithBuffers<TSocketFut, TSocket, TNow>

§

impl<TSocketFut, TSocket, TNow> Send for WithBuffers<TSocketFut, TSocket, TNow>
where TSocketFut: Send, TSocket: Send, TNow: Send,

§

impl<TSocketFut, TSocket, TNow> Sync for WithBuffers<TSocketFut, TSocket, TNow>
where TSocketFut: Sync, TSocket: Sync, TNow: Sync,

§

impl<TSocketFut, TSocket, TNow> !UnwindSafe for WithBuffers<TSocketFut, TSocket, TNow>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

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
source§

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

source§

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<T> IntoEither for T

source§

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
source§

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
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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