Struct xpcom::interfaces::nsIStreamConverter
[−]
[src]
#[repr(C)]pub struct nsIStreamConverter { /* fields omitted */ }
interface nsIStreamConverter : nsIStreamListener
/**
* nsIStreamConverter provides an interface to implement when you have code
* that converts data from one type to another.
*
* Suppose you had code that converted plain text into HTML. You could implement
* this interface to allow everyone else to use your conversion logic using a
* standard api.
* <p>
* <b>STREAM CONVERTER USERS</b>
*
* There are currently two ways to use a stream converter:
* <ol>
* <li> <b>SYNCHRONOUS</b> Stream to Stream
* You can supply the service with a stream of type X
* and it will convert it to your desired output type and return
* a converted (blocking) stream to you.</li>
*
* <li> <b>ASYNCHRONOUS</b> nsIStreamListener to nsIStreamListener
* You can supply data directly to the converter by calling it's
* nsIStreamListener::OnDataAvailable() method. It will then
* convert that data from type X to your desired output type and
* return converted data to you via the nsIStreamListener you passed
* in by calling its OnDataAvailable() method.</li>
* </ol>
* <p>
*
* <b>STREAM CONVERTER SUPPLIERS</b>
*
* Registering a stream converter:
* Stream converter registration is a two step process. First of all the stream
* converter implementation must register itself with the component manager using
* a contractid in the format below. Second, the stream converter must add the contractid
* to the registry.
*
* Stream converter contractid format (the stream converter root key is defined in this
* file):
*
* <pre>@mozilla.org/streamconv;1?from=FROM_MIME_TYPE&to=TO_MIME_TYPE</pre>
*
* @author Jud Valeski
* @see nsIStreamConverterService
*/
Methods
impl nsIStreamConverter
[src]
pub fn coerce<T: nsIStreamConverterCoerce>(&self) -> &T
[src]
Cast this nsIStreamConverter
to one of its base interfaces.
impl nsIStreamConverter
[src]
pub unsafe fn Convert(
&self,
aFromStream: *const nsIInputStream,
aFromType: *const c_char,
aToType: *const c_char,
aCtxt: *const nsISupports,
_retval: *mut *const nsIInputStream
) -> nsresult
[src]
&self,
aFromStream: *const nsIInputStream,
aFromType: *const c_char,
aToType: *const c_char,
aCtxt: *const nsISupports,
_retval: *mut *const nsIInputStream
) -> nsresult
/**
* <b>SYNCRONOUS VERSION</b>
* Converts a stream of one type, to a stream of another type.
*
* Use this method when you have a stream you want to convert.
*
* @param aFromStream The stream representing the original/raw data.
* @param aFromType The MIME type of aFromStream.
* @param aToType The MIME type of the returned stream.
* @param aCtxt Either an opaque context, or a converter specific context
* (implementation specific).
* @return The converted stream. NOTE: The returned stream may not
* already be converted. An efficient stream converter
* implementation will converter data on demand rather than
* buffering the converted data until it is used.
*/
nsIInputStream convert (in nsIInputStream aFromStream, in string aFromType, in string aToType, in nsISupports aCtxt);
pub unsafe fn AsyncConvertData(
&self,
aFromType: *const c_char,
aToType: *const c_char,
aListener: *const nsIStreamListener,
aCtxt: *const nsISupports
) -> nsresult
[src]
&self,
aFromType: *const c_char,
aToType: *const c_char,
aListener: *const nsIStreamListener,
aCtxt: *const nsISupports
) -> nsresult
/**
* <b>ASYNCRONOUS VERSION</b>
* Converts data arriving via the converter's nsIStreamListener::OnDataAvailable()
* method from one type to another, pushing the converted data out to the caller
* via aListener::OnDataAvailable().
*
* Use this method when you want to proxy (and convert) nsIStreamListener callbacks
* asynchronously.
*
* @param aFromType The MIME type of the original/raw data.
* @param aToType The MIME type of the converted data.
* @param aListener The listener who receives the converted data.
* @param aCtxt Either an opaque context, or a converter specific context
* (implementation specific).
*/
void asyncConvertData (in string aFromType, in string aToType, in nsIStreamListener aListener, in nsISupports aCtxt);
Methods from Deref<Target = nsIStreamListener>
pub fn coerce<T: nsIStreamListenerCoerce>(&self) -> &T
[src]
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
[src]
&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 nsIStreamConverter
[src]
const IID: nsIID
IID: nsIID = nsID(191769705, 23797, 18608, [157, 253, 201, 89, 80, 226, 204, 123])
fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>
[src]
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. Read more
impl RefCounted for nsIStreamConverter
[src]
unsafe fn addref(&self)
[src]
Increment the reference count.
unsafe fn release(&self)
[src]
Decrement the reference count, potentially freeing backing memory.
impl Deref for nsIStreamConverter
[src]
type Target = nsIStreamListener
The resulting type after dereferencing.
fn deref(&self) -> &nsIStreamListener
[src]
Dereferences the value.