Struct WritableStream

#[repr(C)]
pub struct WritableStream {
    reflector_: Reflector,
    backpressure: Cell<bool>,
    close_request: DomRefCell<Option<Rc<Promise>>>,
    controller: MutNullableDom<WritableStreamDefaultController>,
    detached: Cell<bool>,
    in_flight_write_request: DomRefCell<Option<Rc<Promise>>>,
    in_flight_close_request: DomRefCell<Option<Rc<Promise>>>,
    pending_abort_request: DomRefCell<Option<PendingAbortRequest>>,
    state: Cell<WritableStreamState>,
    stored_error: Heap<JSVal>,
    writer: MutNullableDom<WritableStreamDefaultWriter>,
    write_requests: DomRefCell<VecDeque<Rc<Promise>>>,
}

https://streams.spec.whatwg.org/#ws-class

Fields

reflector_: Reflector

backpressure: Cell<bool>

https://streams.spec.whatwg.org/#writablestream-backpressure

close_request: DomRefCell<Option<Rc<Promise>>>

https://streams.spec.whatwg.org/#writablestream-closerequest

controller: MutNullableDom<WritableStreamDefaultController>

https://streams.spec.whatwg.org/#writablestream-controller

detached: Cell<bool>

https://streams.spec.whatwg.org/#writablestream-detached

in_flight_write_request: DomRefCell<Option<Rc<Promise>>>

https://streams.spec.whatwg.org/#writablestream-inflightwriterequest

in_flight_close_request: DomRefCell<Option<Rc<Promise>>>

https://streams.spec.whatwg.org/#writablestream-inflightcloserequest

pending_abort_request: DomRefCell<Option<PendingAbortRequest>>

https://streams.spec.whatwg.org/#writablestream-pendingabortrequest

state: Cell<WritableStreamState>

https://streams.spec.whatwg.org/#writablestream-state

stored_error: Heap<JSVal>

https://streams.spec.whatwg.org/#writablestream-storederror

writer: MutNullableDom<WritableStreamDefaultWriter>

https://streams.spec.whatwg.org/#writablestream-writer

write_requests: DomRefCell<VecDeque<Rc<Promise>>>

https://streams.spec.whatwg.org/#writablestream-writerequests

Implementations

impl WritableStream

fn __assert_parent_type(&self)

impl WritableStream

fn new_inherited() -> WritableStream

https://streams.spec.whatwg.org/#initialize-readable-stream

fn new_with_proto( global: &GlobalScope, proto: Option<SafeHandleObject<'_>>, can_gc: CanGc, ) -> DomRoot<WritableStream>

pub(crate) fn assert_no_controller(&self)

Used as part of https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller

pub(crate) fn set_default_controller( &self, controller: &WritableStreamDefaultController, )

Used as part of https://streams.spec.whatwg.org/#set-up-writable-stream-default-controller

pub(crate) fn is_writable(&self) -> bool

pub(crate) fn is_erroring(&self) -> bool

pub(crate) fn is_errored(&self) -> bool

pub(crate) fn is_closed(&self) -> bool

pub(crate) fn has_in_flight_write_request(&self) -> bool

pub(crate) fn has_operations_marked_inflight(&self) -> bool

https://streams.spec.whatwg.org/#writable-stream-has-operation-marked-in-flight

pub(crate) fn get_stored_error(&self, handle_mut: SafeMutableHandleValue<'_>)

https://streams.spec.whatwg.org/#writablestream-storederror

pub(crate) fn finish_erroring( &self, cx: SafeJSContext, global: &GlobalScope, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-finish-erroring

fn reject_close_and_closed_promise_if_needed( &self, cx: SafeJSContext, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-reject-close-and-closed-promise-if-needed

pub(crate) fn close_queued_or_in_flight(&self) -> bool

https://streams.spec.whatwg.org/#writable-stream-close-queued-or-in-flight

pub(crate) fn finish_in_flight_write(&self, can_gc: CanGc)

https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write

pub(crate) fn start_erroring( &self, cx: SafeJSContext, global: &GlobalScope, error: SafeHandleValue<'_>, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-start-erroring

pub(crate) fn deal_with_rejection( &self, cx: SafeJSContext, global: &GlobalScope, error: SafeHandleValue<'_>, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-deal-with-rejection

pub(crate) fn mark_first_write_request_in_flight(&self)

https://streams.spec.whatwg.org/#writable-stream-mark-first-write-request-in-flight

pub(crate) fn mark_close_request_in_flight(&self)

https://streams.spec.whatwg.org/#writable-stream-mark-close-request-in-flight

pub(crate) fn finish_in_flight_close(&self, cx: SafeJSContext, can_gc: CanGc)

https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close

pub(crate) fn finish_in_flight_close_with_error( &self, cx: SafeJSContext, global: &GlobalScope, error: SafeHandleValue<'_>, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-close-with-error

pub(crate) fn finish_in_flight_write_with_error( &self, cx: SafeJSContext, global: &GlobalScope, error: SafeHandleValue<'_>, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-finish-in-flight-write-with-error

pub(crate) fn get_writer(&self) -> Option<DomRoot<WritableStreamDefaultWriter>>

pub(crate) fn set_writer(&self, writer: Option<&WritableStreamDefaultWriter>)

pub(crate) fn set_backpressure(&self, backpressure: bool)

pub(crate) fn get_backpressure(&self) -> bool

pub(crate) fn is_locked(&self) -> bool

https://streams.spec.whatwg.org/#is-writable-stream-locked

pub(crate) fn add_write_request( &self, global: &GlobalScope, can_gc: CanGc, ) -> Rc<Promise>

https://streams.spec.whatwg.org/#writable-stream-add-write-request

pub(crate) fn get_controller( &self, ) -> Option<DomRoot<WritableStreamDefaultController>>

pub(crate) fn abort( &self, cx: SafeJSContext, global: &GlobalScope, provided_reason: SafeHandleValue<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://streams.spec.whatwg.org/#writable-stream-abort

pub(crate) fn close( &self, cx: SafeJSContext, global: &GlobalScope, can_gc: CanGc, ) -> Rc<Promise>

https://streams.spec.whatwg.org/#writable-stream-close

pub(crate) fn get_desired_size(&self) -> Option<f64>

https://streams.spec.whatwg.org/#writable-stream-default-writer-get-desired-size Note: implement as a stream method, as opposed to a writer one, for convenience.

pub(crate) fn aquire_default_writer( &self, cx: SafeJSContext, global: &GlobalScope, can_gc: CanGc, ) -> Result<DomRoot<WritableStreamDefaultWriter>, Error>

https://streams.spec.whatwg.org/#acquire-writable-stream-default-writer

pub(crate) fn update_backpressure( &self, backpressure: bool, global: &GlobalScope, can_gc: CanGc, )

https://streams.spec.whatwg.org/#writable-stream-update-backpressure

Trait Implementations

impl DomObject for WritableStream

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

impl DomObjectWrap<DomTypeHolder> for WritableStream

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::GenericBindings::WritableStreamBinding::WritableStream_Binding::Wrap::<dom::bindings::codegen::DomTypeHolder::DomTypeHolder> as for<'a, 'b> unsafe fn(script_bindings::script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::writablestream::WritableStream>, script_bindings::script_runtime::CanGc) -> script_bindings::root::Root<script_bindings::root::Dom<dom::writablestream::WritableStream>>}

Function pointer to the general wrap function type

impl HasParent for WritableStream

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 WritableStream

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

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for WritableStream

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 WritableStream

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

Initializes the Reflector

impl PartialEq for WritableStream

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ToJSValConvertible for WritableStream

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

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

impl Traceable for WritableStream

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

Trace self.

impl WritableStreamMethods<DomTypeHolder> for WritableStream

fn Constructor( cx: SafeJSContext, global: &GlobalScope, proto: Option<SafeHandleObject<'_>>, can_gc: CanGc, underlying_sink: Option<*mut JSObject>, strategy: &QueuingStrategy<DomTypeHolder>, ) -> Fallible<DomRoot<WritableStream>>

https://streams.spec.whatwg.org/#ws-constructor

fn Locked(&self) -> bool

https://streams.spec.whatwg.org/#ws-locked

fn Abort( &self, cx: SafeJSContext, reason: SafeHandleValue<'_>, realm: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://streams.spec.whatwg.org/#ws-abort

fn Close(&self, realm: InRealm<'_>, can_gc: CanGc) -> Rc<Promise>

https://streams.spec.whatwg.org/#ws-close

fn GetWriter( &self, realm: InRealm<'_>, can_gc: CanGc, ) -> Result<DomRoot<WritableStreamDefaultWriter>, Error>

https://streams.spec.whatwg.org/#ws-get-writer

impl Eq for WritableStream