Struct script::dom::underlyingsourcecontainer::UnderlyingSourceContainer

#[repr(C)]
pub struct UnderlyingSourceContainer {
    reflector_: Reflector,
    underlying_source_type: UnderlyingSourceType,
}

Wrapper around the underlying source.

Fields

reflector_: Reflector

underlying_source_type: UnderlyingSourceType

Implementations

impl UnderlyingSourceContainer

fn __assert_parent_type(&self)

impl UnderlyingSourceContainer

fn new_inherited( underlying_source_type: UnderlyingSourceType, ) -> UnderlyingSourceContainer

pub fn new( global: &GlobalScope, underlying_source_type: UnderlyingSourceType, can_gc: CanGc, ) -> Root<Dom<UnderlyingSourceContainer>>

pub fn set_underlying_source_this_object(&self, object: HandleObject<'_>)

Setting the JS object after the heap has settled down.

pub fn call_cancel_algorithm( &self, reason: SafeHandleValue<'_>, can_gc: CanGc, ) -> Option<Result<Rc<Promise>, Error>>

https://streams.spec.whatwg.org/#dom-underlyingsource-cancel

pub fn call_pull_algorithm( &self, controller: Controller, can_gc: CanGc, ) -> Option<Result<Rc<Promise>, Error>>

https://streams.spec.whatwg.org/#dom-underlyingsource-pull

pub fn call_start_algorithm( &self, controller: Controller, can_gc: CanGc, ) -> Option<Result<Rc<Promise>, Error>>

https://streams.spec.whatwg.org/#dom-underlyingsource-start

Note: The algorithm can return any value, including a promise, we always transform the result into a promise for convenience, and it is also how to spec deals with the situation. see “Let startPromise be a promise resolved with startResult.” at https://streams.spec.whatwg.org/#set-up-readable-stream-default-controller

pub fn in_memory(&self) -> bool

Does the source have all data in memory?

Trait Implementations

impl DomObject for UnderlyingSourceContainer

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 UnderlyingSourceContainer

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::UnderlyingSourceContainerBinding::UnderlyingSourceContainer_Binding::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::underlyingsourcecontainer::UnderlyingSourceContainer>, script_runtime::CanGc) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::underlyingsourcecontainer::UnderlyingSourceContainer>>}

Function pointer to the general wrap function type

impl HasParent for UnderlyingSourceContainer

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 UnderlyingSourceContainer

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

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for UnderlyingSourceContainer

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 UnderlyingSourceContainer

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

Initializes the Reflector

impl PartialEq for UnderlyingSourceContainer

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 UnderlyingSourceContainer

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

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

impl Traceable for UnderlyingSourceContainer

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

Trace self.

impl Eq for UnderlyingSourceContainer