Struct xpcom::interfaces::nsIUploadChannel
[−]
[src]
#[repr(C)]pub struct nsIUploadChannel { /* fields omitted */ }
interface nsIUploadChannel : nsISupports
/**
* nsIUploadChannel
*
* A channel may optionally implement this interface if it supports the
* notion of uploading a data stream. The upload stream may only be set
* prior to the invocation of asyncOpen on the channel.
*/
Methods
impl nsIUploadChannel
[src]
pub fn coerce<T: nsIUploadChannelCoerce>(&self) -> &T
[src]
Cast this nsIUploadChannel
to one of its base interfaces.
impl nsIUploadChannel
[src]
pub unsafe fn SetUploadStream(
&self,
aStream: *const nsIInputStream,
aContentType: &nsACString,
aContentLength: int64_t
) -> nsresult
[src]
&self,
aStream: *const nsIInputStream,
aContentType: &nsACString,
aContentLength: int64_t
) -> nsresult
/**
* Sets a stream to be uploaded by this channel.
*
* Most implementations of this interface require that the stream:
* (1) implement threadsafe addRef and release
* (2) implement nsIInputStream::readSegments
* (3) implement nsISeekableStream::seek
*
* History here is that we need to support both streams that already have
* headers (e.g., Content-Type and Content-Length) information prepended to
* the stream (by plugins) as well as clients (composer, uploading
* application) that want to upload data streams without any knowledge of
* protocol specifications. For this reason, we have a special meaning
* for the aContentType parameter (see below).
*
* @param aStream
* The stream to be uploaded by this channel.
* @param aContentType
* If aContentType is empty, the protocol will assume that no
* content headers are to be added to the uploaded stream and that
* any required headers are already encoded in the stream. In the
* case of HTTP, if this parameter is non-empty, then its value will
* replace any existing Content-Type header on the HTTP request.
* In the case of FTP and FILE, this parameter is ignored.
* @param aContentLength
* A value of -1 indicates that the length of the stream should be
* determined by calling the stream's |available| method.
*/
void setUploadStream (in nsIInputStream aStream, in ACString aContentType, in long long aContentLength);
pub unsafe fn GetUploadStream(
&self,
aUploadStream: *mut *const nsIInputStream
) -> nsresult
[src]
&self,
aUploadStream: *mut *const nsIInputStream
) -> nsresult
/**
* Get the stream (to be) uploaded by this channel.
*/
readonly attribute nsIInputStream uploadStream;
Methods from Deref<Target = nsISupports>
pub fn coerce<T: nsISupportsCoerce>(&self) -> &T
[src]
Cast this nsISupports
to one of its base interfaces.
pub unsafe fn QueryInterface(
&self,
uuid: &nsIID,
result: *mut *mut c_void
) -> nsresult
[src]
&self,
uuid: &nsIID,
result: *mut *mut c_void
) -> nsresult
void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);
pub unsafe fn AddRef(&self) -> nsrefcnt
[src]
[noscript,notxpcom] nsrefcnt AddRef ();
pub unsafe fn Release(&self) -> nsrefcnt
[src]
[noscript,notxpcom] nsrefcnt Release ();
Trait Implementations
impl XpCom for nsIUploadChannel
[src]
const IID: nsIID
IID: nsIID = nsID(1560155581, 23259, 19071, [158, 85, 79, 90, 103, 209, 87, 148])
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 nsIUploadChannel
[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 nsIUploadChannel
[src]
type Target = nsISupports
The resulting type after dereferencing.
fn deref(&self) -> &nsISupports
[src]
Dereferences the value.