Struct xpcom::interfaces::nsISimpleStreamListener

#[repr(C)]
pub struct nsISimpleStreamListener { /* fields omitted */ }

interface nsISimpleStreamListener : nsIStreamListener

/**
 * A simple stream listener can be used with AsyncRead to supply data to
 * a output stream.
 */

Methods

impl nsISimpleStreamListener

pub fn coerce<T: nsISimpleStreamListenerCoerce>(&self) -> &T

Cast this nsISimpleStreamListener to one of its base interfaces.

impl nsISimpleStreamListener

pub unsafe fn Init(
    &self,
    aSink: *const nsIOutputStream,
    aObserver: *const nsIRequestObserver
) -> nsresult

/**
     * Initialize the simple stream listener.
     *
     * @param aSink data will be read from the channel to this output stream.
     *              Must implement writeFrom.
     * @param aObserver optional stream observer (can be NULL)
     */

void init (in nsIOutputStream aSink, in nsIRequestObserver aObserver);

Methods from Deref<Target = nsIStreamListener>

pub fn coerce<T: nsIStreamListenerCoerce>(&self) -> &T

Cast this nsIStreamListener to one of its base interfaces.

pub unsafe fn OnDataAvailable(
    &self,
    aRequest: *const nsIRequest,
    aContext: *const nsISupports,
    aInputStream: *const nsIInputStream,
    aOffset: uint64_t,
    aCount: uint32_t
) -> nsresult

/**
     * Called when the next chunk of data (corresponding to the request) may
     * be read without blocking the calling thread.  The onDataAvailable impl
     * must read exactly |aCount| bytes of data before returning.
     *
     * @param aRequest request corresponding to the source of the data
     * @param aContext user defined context
     * @param aInputStream input stream containing the data chunk
     * @param aOffset
     *        Number of bytes that were sent in previous onDataAvailable calls
     *        for this request. In other words, the sum of all previous count
     *        parameters.
     * @param aCount number of bytes available in the stream
     *
     * NOTE: The aInputStream parameter must implement readSegments.
     *
     * An exception thrown from onDataAvailable has the side-effect of
     * causing the request to be canceled.
     */

void onDataAvailable (in nsIRequest aRequest, in nsISupports aContext, in nsIInputStream aInputStream, in unsigned long long aOffset, in unsigned long aCount);

Trait Implementations

impl XpCom for nsISimpleStreamListener

const IID: nsIID

IID: nsIID = nsID(2847428458, 2084, 17016, [186, 230, 191, 202, 5, 112, 162, 110])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsISimpleStreamListener

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsISimpleStreamListener

type Target = nsIStreamListener

The resulting type after dereferencing.

fn deref(&self) -> &nsIStreamListener

Dereferences the value.