Struct script::dom::readablestream::ReadableStream

#[repr(C)]
pub struct ReadableStream {
    reflector_: Reflector,
    js_stream: Heap<*mut JSObject>,
    js_reader: Heap<*mut JSObject>,
    has_reader: Cell<bool>,
    external_underlying_source: Option<Rc<ExternalUnderlyingSourceController>>,
}

Fields

reflector_: Reflector

js_stream: Heap<*mut JSObject>

js_reader: Heap<*mut JSObject>

has_reader: Cell<bool>

external_underlying_source: Option<Rc<ExternalUnderlyingSourceController>>

Implementations

impl ReadableStream

fn __assert_parent_type(&self)

impl ReadableStream

fn new_inherited(
    external_underlying_source: Option<Rc<ExternalUnderlyingSourceController>>
) -> ReadableStream

fn new(
    global: &GlobalScope,
    external_underlying_source: Option<Rc<ExternalUnderlyingSourceController>>
) -> Root<Dom<ReadableStream>>

pub unsafe fn from_js(
    cx: SafeJSContext,
    obj: *mut JSObject,
    realm: InRealm<'_>
) -> Result<Root<Dom<ReadableStream>>, ()>

Used from RustCodegen.py

pub fn new_from_bytes(
    global: &GlobalScope,
    bytes: Vec<u8>
) -> Root<Dom<ReadableStream>>

Build a stream backed by a Rust source that has already been read into memory.

pub fn new_with_external_underlying_source(
    global: &GlobalScope,
    source: ExternalUnderlyingSource
) -> Root<Dom<ReadableStream>>

Build a stream backed by a Rust underlying source.

pub fn get_js_stream(&self) -> NonNull<JSObject>

Get a pointer to the underlying JS object.

pub fn enqueue_native(&self, bytes: Vec<u8>)

pub fn error_native(&self, error: Error)

pub fn close_native(&self)

pub fn in_memory(&self) -> bool

Does the stream have all data in memory?

pub fn get_in_memory_bytes(&self) -> Option<Vec<u8>>

Return bytes for synchronous use, if the stream has all data in memory.

pub fn start_reading(&self) -> Result<(), ()>

Acquires a reader and locks the stream, must be done before read_a_chunk.

pub fn read_a_chunk(&self) -> Rc<Promise>

Read a chunk from the stream, must be called after start_reading, and before stop_reading.

pub fn stop_reading(&self)

Releases the lock on the reader, must be done after start_reading.

pub fn is_locked(&self) -> bool

pub fn is_disturbed(&self) -> bool

Trait Implementations

impl DomObject for ReadableStream

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>where
    Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for ReadableStream

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::ReadableStreamBinding::ReadableStreamBinding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::readablestream::ReadableStream>) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::readablestream::ReadableStream>>}

Function pointer to the general wrap function type

impl HasParent for ReadableStream

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl IDLInterface for ReadableStream

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl JSTraceable for ReadableStream

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl MallocSizeOf for ReadableStream

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for ReadableStream

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq<ReadableStream> for ReadableStream

fn eq(&self, other: &ReadableStream) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToJSValConvertible for ReadableStream

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.