Struct mozjs_sys::jsapi::JS::OptimizedEncodingListener

#[repr(C)]
pub struct OptimizedEncodingListener {
    pub vtable_: *const OptimizedEncodingListener__bindgen_vtable,
}

The ConsumeStreamCallback is called from an active JSContext, passing a StreamConsumer that wishes to consume the given host object as a stream of bytes with the given MIME type. On failure, the embedding must report the appropriate error on ‘cx’. On success, the embedding must call consumer->consumeChunk() repeatedly on any thread until exactly one of:

• consumeChunk() returns false
• the embedding calls consumer->streamEnd()
• the embedding calls consumer->streamError() before JS_DestroyContext(cx) or JS::ShutdownAsyncTasks(cx) is called.

Note: consumeChunk(), streamEnd() and streamError() may be called synchronously by ConsumeStreamCallback.

When streamEnd() is called, the embedding may optionally pass an OptimizedEncodingListener*, indicating that there is a cache entry associated with this stream that can store an optimized encoding of the bytes that were just streamed at some point in the future by having SpiderMonkey call storeOptimizedEncoding(). Until the optimized encoding is ready, SpiderMonkey will hold an outstanding refcount to keep the listener alive.

After storeOptimizedEncoding() is called, on cache hit, the embedding may call consumeOptimizedEncoding() instead of consumeChunk()/streamEnd(). The embedding must ensure that the GetOptimizedEncodingBuildId() (see js/BuildId.h) at the time when an optimized encoding is created is the same as when it is later consumed.

Fields

vtable_: *const OptimizedEncodingListener__bindgen_vtable

Trait Implementations

impl Debug for OptimizedEncodingListener

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OptimizedEncodingListener

fn eq(&self, other: &OptimizedEncodingListener) -> 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 StructuralPartialEq for OptimizedEncodingListener