Skip to main content

Mode

Enum Mode 

Source
pub enum Mode {
    Byob {
        reader: ReadableStreamByobReader,
        internal_buf: Option<ArrayBuffer>,
    },
    Default {
        reader: ReadableStreamDefaultReader,
    },
}
Expand description

The underlying stream reader.

A BYOB reader is used when the stream is a byte stream; a default reader is the fallback for the streams that do not support BYOB reads.

Variants§

§

Byob

A BYOB reader; reads into the owned internal buffer.

Fields

§reader: ReadableStreamByobReader

The reader itself.

§internal_buf: Option<ArrayBuffer>

The owned buffer to pass to the reads.

None when the buffer ownership is currently transferred to a pending read, or when the buffer has not been allocated yet.

§

Default

A default reader; yields stream-allocated chunks.

Fields

§reader: ReadableStreamDefaultReader

The reader itself.

Implementations§

Source§

impl Mode

Source

pub fn release_lock(&self)

Release the stream lock held by the reader.

Source

pub fn cancel_with_reason(&self, reason: &JsValue) -> Promise

Cancel the stream with the given reason.

Source

pub fn closed(&self) -> Promise

A promise that settles when the stream closes or errors.

Trait Implementations§

Source§

impl Debug for Mode

Source§

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

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

impl From<ReadableStreamByobReader> for Mode

Source§

fn from(reader: ReadableStreamByobReader) -> Self

Converts to this type from the input type.
Source§

impl From<ReadableStreamDefaultReader> for Mode

Source§

fn from(reader: ReadableStreamDefaultReader) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Mode

§

impl RefUnwindSafe for Mode

§

impl Send for Mode

§

impl Sync for Mode

§

impl Unpin for Mode

§

impl UnsafeUnpin for Mode

§

impl UnwindSafe for Mode

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more