Struct TransformStreamDefaultController

#[repr(C)]
pub struct TransformStreamDefaultController {
    reflector_: Reflector,
    transformer_type: TransformerType,
    stream: MutNullableDom<TransformStream>,
    finish_promise: DomRefCell<Option<Rc<Promise>>>,
}

https://streams.spec.whatwg.org/#transformstreamdefaultcontroller

Fields

reflector_: Reflector

transformer_type: TransformerType

The type of the underlying transformer used. Besides the JS variant, there will be other variant(s) for TextDecoderStream

stream: MutNullableDom<TransformStream>

https://streams.spec.whatwg.org/#TransformStreamDefaultController-stream

finish_promise: DomRefCell<Option<Rc<Promise>>>

https://streams.spec.whatwg.org/#transformstreamdefaultcontroller-finishpromise

Implementations

impl TransformStreamDefaultController

fn __assert_parent_type(&self)

impl TransformStreamDefaultController

fn new_inherited( transformer_type: TransformerType, ) -> TransformStreamDefaultController

pub(crate) fn new( global: &GlobalScope, transformer_type: TransformerType, can_gc: CanGc, ) -> DomRoot<TransformStreamDefaultController>

pub(crate) fn set_transform_obj(&self, this_object: SafeHandleObject<'_>)

Setting the JS object after the heap has settled down.

Note that this has no effect if the transformer type is not TransformerType::Js

pub(crate) fn set_stream(&self, stream: &TransformStream)

pub(crate) fn get_finish_promise(&self) -> Option<Rc<Promise>>

pub(crate) fn set_finish_promise(&self, promise: Rc<Promise>)

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

https://streams.spec.whatwg.org/#transform-stream-default-controller-perform-transform

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

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

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

pub(crate) fn enqueue( &self, cx: SafeJSContext, global: &GlobalScope, chunk: SafeHandleValue<'_>, can_gc: CanGc, ) -> Fallible<()>

https://streams.spec.whatwg.org/#transform-stream-default-controller-enqueue

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

https://streams.spec.whatwg.org/#transform-stream-default-controller-error

pub(crate) fn clear_algorithms(&self)

https://streams.spec.whatwg.org/#transform-stream-default-controller-clear-algorithms

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

https://streams.spec.whatwg.org/#transform-stream-default-controller-terminate

Trait Implementations

impl DomObject for TransformStreamDefaultController

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

impl DomObjectWrap<DomTypeHolder> for TransformStreamDefaultController

const WRAP: unsafe fn(SafeJSContext, &GlobalScope, Option<HandleObject<'_>>, Box<Self>, CanGc) -> Root<Dom<Self>> = {script_bindings::codegen::GenericBindings::TransformStreamDefaultControllerBinding::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::transformstreamdefaultcontroller::TransformStreamDefaultController>, script_bindings::script_runtime::CanGc) -> script_bindings::root::Root<script_bindings::root::Dom<dom::transformstreamdefaultcontroller::TransformStreamDefaultController>>}

Function pointer to the general wrap function type

impl HasParent for TransformStreamDefaultController

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 TransformStreamDefaultController

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

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for TransformStreamDefaultController

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 TransformStreamDefaultController

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

Initializes the Reflector

impl PartialEq for TransformStreamDefaultController

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 TransformStreamDefaultController

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

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

impl Traceable for TransformStreamDefaultController

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

Trace self.

impl TransformStreamDefaultControllerMethods<DomTypeHolder> for TransformStreamDefaultController

fn GetDesiredSize(&self) -> Option<f64>

https://streams.spec.whatwg.org/#ts-default-controller-desired-size

fn Enqueue( &self, cx: SafeJSContext, chunk: SafeHandleValue<'_>, can_gc: CanGc, ) -> Fallible<()>

https://streams.spec.whatwg.org/#ts-default-controller-enqueue

fn Error( &self, cx: SafeJSContext, reason: SafeHandleValue<'_>, can_gc: CanGc, ) -> Fallible<()>

https://streams.spec.whatwg.org/#ts-default-controller-error

fn Terminate(&self, can_gc: CanGc) -> Fallible<()>

https://streams.spec.whatwg.org/#ts-default-controller-terminate

impl Eq for TransformStreamDefaultController