Struct xpcom::interfaces::nsIFormPOSTActionChannel [] [src]

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

interface nsIFormPOSTActionChannel : nsIUploadChannel

/**
 * nsIFormPOSTActionChannel
 *
 * Channel classes that want to be allowed for HTML form POST action must
 * implement this interface.
 */

Methods

impl nsIFormPOSTActionChannel
[src]

[src]

Cast this nsIFormPOSTActionChannel to one of its base interfaces.

Methods from Deref<Target = nsIUploadChannel>

[src]

Cast this nsIUploadChannel to one of its base interfaces.

[src]

/**
     * 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);

[src]

/**
     * Get the stream (to be) uploaded by this channel.
     */

readonly attribute nsIInputStream uploadStream;

Trait Implementations

impl XpCom for nsIFormPOSTActionChannel
[src]

IID: nsIID = nsID(4236405587, 3512, 17076, [170, 106, 93, 210, 207, 202, 82, 164])

[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 nsIFormPOSTActionChannel
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIFormPOSTActionChannel
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.