Struct ReadableStream 

pub struct ReadableStream<'js> {
    pub controller: ReadableStreamControllerClass<'js>,
    pub disturbed: bool,
    pub state: ReadableStreamState<'js>,
    /* private fields */
}

Fields

controller: ReadableStreamControllerClass<'js>

disturbed: bool

state: ReadableStreamState<'js>

Implementations

impl<'js> ReadableStream<'js>

pub fn is_readable_stream_locked(&self) -> bool

pub fn from_pull_algorithm( ctx: Ctx<'js>, pull_algorithm: PullAlgorithm<'js>, cancel_algorithm: CancelAlgorithm<'js>, ) -> Result<Class<'js, Self>>

Create a ReadableStream from Rust pull/cancel algorithms

pub fn from_pull_algorithm_with_options( ctx: Ctx<'js>, pull_algorithm: PullAlgorithm<'js>, cancel_algorithm: CancelAlgorithm<'js>, high_water_mark: Option<f64>, ) -> Result<Class<'js, Self>>

Create a ReadableStream from Rust pull/cancel algorithms with custom highWaterMark

pub fn from_byte_pull_algorithm( ctx: Ctx<'js>, pull_algorithm: PullAlgorithm<'js>, cancel_algorithm: CancelAlgorithm<'js>, ) -> Result<Class<'js, Self>>

Create a byte-source ReadableStream (i.e. type: "bytes") from Rust pull/cancel algorithms. BYOB readers can attach to the returned stream, and the pull algorithm receives a byte controller so it can enqueue Uint8Array chunks that stream directly into BYOB reads without copying.

pub fn create_readable_byte_stream( ctx: Ctx<'js>, start_algorithm: StartAlgorithm<'js>, pull_algorithm: PullAlgorithm<'js>, cancel_algorithm: CancelAlgorithm<'js>, ) -> Result<(Class<'js, Self>, ReadableByteStreamControllerClass<'js>)>

Trait Implementations

impl<'js> ConstructorCreator<'js, ReadableStream<'js>> for ConstructorCreate<ReadableStream<'js>>

fn create_constructor(&self, ctx: &Ctx<'js>) -> Result<Option<Constructor<'js>>>

impl<'js> FromJs<'js> for ReadableStream<'js>

where for<'a> CloneWrapper<'a, Self>: CloneTrait<Self>,

fn from_js(ctx: &Ctx<'js>, value: Value<'js>) -> Result<Self>

impl<'js> IntoJs<'js> for ReadableStream<'js>

fn into_js(self, ctx: &Ctx<'js>) -> Result<Value<'js>>

impl<'js> JsClass<'js> for ReadableStream<'js>

const NAME: &'static str = "ReadableStream"

The name the constructor has in JavaScript

type Mutable = Writable

Can the type be mutated while a JavaScript value.

fn prototype(ctx: &Ctx<'js>) -> Result<Option<Object<'js>>>

Returns the class prototype,

fn constructor(ctx: &Ctx<'js>) -> Result<Option<Constructor<'js>>>

Returns a predefined constructor for this specific class type if there is one.

const KIND: ClassKind = ClassKind::Plain

The kind of this class (plain, callable, or exotic).

fn call<'a>( this: &JsCell<'js, Self>, params: Params<'a, 'js>, ) -> Result<Value<'js>, Error>

The function which will be called if Self::KIND is ClassKind::Callable and an object with this class is called as if it is a function.

fn exotic_get_property( this: &JsCell<'js, Self>, ctx: &Ctx<'js>, _atom: Atom<'js>, _receiver: Value<'js>, ) -> Result<Value<'js>, Error>

The function which will be called if a get property is performed on an object with this class

fn exotic_set_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, _receiver: Value<'js>, _value: Value<'js>, ) -> Result<bool, Error>

The function which will be called if a set property is performed on an object with this class

fn exotic_delete_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, ) -> Result<bool, Error>

The function which will be called if a delete property is performed on an object with this class

fn exotic_has_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, ) -> Result<bool, Error>

The function which will be called if has property or similar is called on an object with this class

fn exotic_get_own_property( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, _atom: Atom<'js>, ) -> Result<Option<PropertyDescriptor<'js>>, Error>

Called to get the own property descriptor for a given property name.

fn exotic_get_own_property_names( this: &JsCell<'js, Self>, _ctx: &Ctx<'js>, ) -> Result<Vec<PropertyName<'js>>, Error>

Called to enumerate the own property names of this object.

impl<'js> JsLifetime<'js> for ReadableStream<'js>

type Changed<'to> = ReadableStream<'to>

The target which has the same type as a Self but with another lifetime 't

impl<'js> MethodImplementor<ReadableStream<'js>> for MethodImpl<ReadableStream<'js>>

fn implement(&self, _proto: &Object<'_>) -> Result<()>

impl<'js> Trace<'js> for ReadableStream<'js>

fn trace<'a>(&self, tracer: Tracer<'a, 'js>)