Struct xpcom::interfaces::nsIWyciwygChannel

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

interface nsIWyciwygChannel : nsIChannel

/**
 * A channel to  manage all cache-related interactions for layout
 * when it is dealing with dynamic pages created through
 * document.write(). This interface provides methods that will
 * help layout save dynamic pages in cache for future retrievals.
 */

Methods

impl nsIWyciwygChannel

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

Cast this nsIWyciwygChannel to one of its base interfaces.

impl nsIWyciwygChannel

pub unsafe fn WriteToCacheEntry(&self, aData: &nsAString) -> nsresult

/**
   * Append data to the cache entry; opens the cache entry if necessary.
   */

void writeToCacheEntry (in AString aData);

pub unsafe fn CloseCacheEntry(&self, reason: nsresult) -> nsresult

/**
   * Close the cache entry; subsequent writes have undefined behavior.
   */

void closeCacheEntry (in nsresult reason);

pub unsafe fn SetSecurityInfo(
    &self,
    aSecurityInfo: *const nsISupports
) -> nsresult

/**
   * Set the wyciwyg channels security info
   */

void setSecurityInfo (in nsISupports aSecurityInfo);

pub unsafe fn SetCharsetAndSource(
    &self,
    aSource: int32_t,
    aCharset: &nsACString
) -> nsresult

/**
   * Store and read a charset and charset source on the wyciwyg channel.  These
   * are opaque values to the channel; consumers who set them should know what
   * they mean.
   */

void setCharsetAndSource (in long aSource, in ACString aCharset);

pub unsafe fn GetCharsetAndSource(
    &self,
    aSource: *mut int32_t,
    _retval: &mut nsACString
) -> nsresult

/**
   * The return value is the charset.  Throws if either the charset or the
   * source cannot be retrieved.  This is guaranteed to return a nonzero source
   * and a nonempty charset if it does not throw.
   */

ACString getCharsetAndSource (out long aSource);

Methods from Deref<Target = nsIChannel>

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

Cast this nsIChannel to one of its base interfaces.

pub const LOAD_DOCUMENT_URI: i64

pub const LOAD_RETARGETED_DOCUMENT_URI: i64

pub const LOAD_REPLACE: i64

pub const LOAD_INITIAL_DOCUMENT_URI: i64

pub const LOAD_TARGETED: i64

pub const LOAD_CALL_CONTENT_SNIFFERS: i64

pub const LOAD_CLASSIFY_URI: i64

pub const LOAD_MEDIA_SNIFFER_OVERRIDES_CONTENT_TYPE: i64

pub const LOAD_EXPLICIT_CREDENTIALS: i64

pub const LOAD_BYPASS_SERVICE_WORKER: i64

pub const DISPOSITION_INLINE: i64

pub const DISPOSITION_ATTACHMENT: i64

pub unsafe fn GetOriginalURI(
    &self,
    aOriginalURI: *mut *const nsIURI
) -> nsresult

/**
 * The nsIChannel interface allows clients to construct "GET" requests for
 * specific protocols, and manage them in a uniform way.  Once a channel is
 * created (via nsIIOService::newChannel), parameters for that request may
 * be set by using the channel attributes, or by QI'ing to a subclass of
 * nsIChannel for protocol-specific parameters.  Then, the URI can be fetched
 * by calling nsIChannel::open or nsIChannel::asyncOpen.
 *
 * After a request has been completed, the channel is still valid for accessing
 * protocol-specific results.  For example, QI'ing to nsIHttpChannel allows
 * response headers to be retrieved for the corresponding http transaction.
 *
 * This interface must be used only from the XPCOM main thread.
 */
/**
     * The original URI used to construct the channel. This is used in
     * the case of a redirect or URI "resolution" (e.g. resolving a
     * resource: URI to a file: URI) so that the original pre-redirect
     * URI can still be obtained.  This is never null.  Attempts to
     * set it to null must throw.
     *
     * NOTE: this is distinctly different from the http Referer (referring URI),
     * which is typically the page that contained the original URI (accessible
     * from nsIHttpChannel).
     */

attribute nsIURI originalURI;

pub unsafe fn SetOriginalURI(&self, aOriginalURI: *const nsIURI) -> nsresult

/**
 * The nsIChannel interface allows clients to construct "GET" requests for
 * specific protocols, and manage them in a uniform way.  Once a channel is
 * created (via nsIIOService::newChannel), parameters for that request may
 * be set by using the channel attributes, or by QI'ing to a subclass of
 * nsIChannel for protocol-specific parameters.  Then, the URI can be fetched
 * by calling nsIChannel::open or nsIChannel::asyncOpen.
 *
 * After a request has been completed, the channel is still valid for accessing
 * protocol-specific results.  For example, QI'ing to nsIHttpChannel allows
 * response headers to be retrieved for the corresponding http transaction.
 *
 * This interface must be used only from the XPCOM main thread.
 */
/**
     * The original URI used to construct the channel. This is used in
     * the case of a redirect or URI "resolution" (e.g. resolving a
     * resource: URI to a file: URI) so that the original pre-redirect
     * URI can still be obtained.  This is never null.  Attempts to
     * set it to null must throw.
     *
     * NOTE: this is distinctly different from the http Referer (referring URI),
     * which is typically the page that contained the original URI (accessible
     * from nsIHttpChannel).
     */

attribute nsIURI originalURI;

pub unsafe fn GetURI(&self, aURI: *mut *const nsIURI) -> nsresult

/**
     * The URI corresponding to the channel.  Its value is immutable.
     */

readonly attribute nsIURI URI;

pub unsafe fn GetOwner(&self, aOwner: *mut *const nsISupports) -> nsresult

/**
     * The owner, corresponding to the entity that is responsible for this
     * channel.  Used by the security manager to grant or deny privileges to
     * mobile code loaded from this channel.
     *
     * NOTE: this is a strong reference to the owner, so if the owner is also
     * holding a strong reference to the channel, care must be taken to
     * explicitly drop its reference to the channel.
     */

attribute nsISupports owner;

pub unsafe fn SetOwner(&self, aOwner: *const nsISupports) -> nsresult

/**
     * The owner, corresponding to the entity that is responsible for this
     * channel.  Used by the security manager to grant or deny privileges to
     * mobile code loaded from this channel.
     *
     * NOTE: this is a strong reference to the owner, so if the owner is also
     * holding a strong reference to the channel, care must be taken to
     * explicitly drop its reference to the channel.
     */

attribute nsISupports owner;

pub unsafe fn GetNotificationCallbacks(
    &self,
    aNotificationCallbacks: *mut *const nsIInterfaceRequestor
) -> nsresult

/**
     * The notification callbacks for the channel.  This is set by clients, who
     * wish to provide a means to receive progress, status and protocol-specific
     * notifications.  If this value is NULL, the channel implementation may use
     * the notification callbacks from its load group.  The channel may also
     * query the notification callbacks from its load group if its notification
     * callbacks do not supply the requested interface.
     *
     * Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt,
     * and nsIAuthPrompt/nsIAuthPrompt2.
     *
     * When the channel is done, it must not continue holding references to
     * this object.
     *
     * NOTE: A channel implementation should take care when "caching" an
     * interface pointer queried from its notification callbacks.  If the
     * notification callbacks are changed, then a cached interface pointer may
     * become invalid and may therefore need to be re-queried.
     */

attribute nsIInterfaceRequestor notificationCallbacks;

pub unsafe fn SetNotificationCallbacks(
    &self,
    aNotificationCallbacks: *const nsIInterfaceRequestor
) -> nsresult

/**
     * The notification callbacks for the channel.  This is set by clients, who
     * wish to provide a means to receive progress, status and protocol-specific
     * notifications.  If this value is NULL, the channel implementation may use
     * the notification callbacks from its load group.  The channel may also
     * query the notification callbacks from its load group if its notification
     * callbacks do not supply the requested interface.
     *
     * Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt,
     * and nsIAuthPrompt/nsIAuthPrompt2.
     *
     * When the channel is done, it must not continue holding references to
     * this object.
     *
     * NOTE: A channel implementation should take care when "caching" an
     * interface pointer queried from its notification callbacks.  If the
     * notification callbacks are changed, then a cached interface pointer may
     * become invalid and may therefore need to be re-queried.
     */

attribute nsIInterfaceRequestor notificationCallbacks;

pub unsafe fn GetSecurityInfo(
    &self,
    aSecurityInfo: *mut *const nsISupports
) -> nsresult

/**
     * Transport-level security information (if any) corresponding to the
     * channel.
     *
     * NOTE: In some circumstances TLS information is propagated onto
     * non-nsIHttpChannel objects to indicate that their contents were likely
     * delivered over TLS all the same.  For example, document.open() may
     * create an nsWyciwygChannel to store the data that will be written to the
     * document.  In that case, if the caller has TLS information, we propagate
     * that info onto the nsWyciwygChannel given that it is likely that the
     * caller will be writing data that was delivered over TLS to the document.
     */

readonly attribute nsISupports securityInfo;

pub unsafe fn GetContentType(&self, aContentType: &mut nsACString) -> nsresult

/**
     * The MIME type of the channel's content if available.
     *
     * NOTE: the content type can often be wrongly specified (e.g., wrong file
     * extension, wrong MIME type, wrong document type stored on a server, etc.),
     * and the caller most likely wants to verify with the actual data.
     *
     * Setting contentType before the channel has been opened provides a hint
     * to the channel as to what the MIME type is.  The channel may ignore this
     * hint in deciding on the actual MIME type that it will report.
     *
     * Setting contentType after onStartRequest has been fired or after open()
     * is called will override the type determined by the channel.
     *
     * Setting contentType between the time that asyncOpen() is called and the
     * time when onStartRequest is fired has undefined behavior at this time.
     *
     * The value of the contentType attribute is a lowercase string.  A value
     * assigned to this attribute will be parsed and normalized as follows:
     *  1- any parameters (delimited with a ';') will be stripped.
     *  2- if a charset parameter is given, then its value will replace the
     *     the contentCharset attribute of the channel.
     *  3- the stripped contentType will be lowercased.
     * Any implementation of nsIChannel must follow these rules.
     */

attribute ACString contentType;

pub unsafe fn SetContentType(&self, aContentType: &nsACString) -> nsresult

/**
     * The MIME type of the channel's content if available.
     *
     * NOTE: the content type can often be wrongly specified (e.g., wrong file
     * extension, wrong MIME type, wrong document type stored on a server, etc.),
     * and the caller most likely wants to verify with the actual data.
     *
     * Setting contentType before the channel has been opened provides a hint
     * to the channel as to what the MIME type is.  The channel may ignore this
     * hint in deciding on the actual MIME type that it will report.
     *
     * Setting contentType after onStartRequest has been fired or after open()
     * is called will override the type determined by the channel.
     *
     * Setting contentType between the time that asyncOpen() is called and the
     * time when onStartRequest is fired has undefined behavior at this time.
     *
     * The value of the contentType attribute is a lowercase string.  A value
     * assigned to this attribute will be parsed and normalized as follows:
     *  1- any parameters (delimited with a ';') will be stripped.
     *  2- if a charset parameter is given, then its value will replace the
     *     the contentCharset attribute of the channel.
     *  3- the stripped contentType will be lowercased.
     * Any implementation of nsIChannel must follow these rules.
     */

attribute ACString contentType;

pub unsafe fn GetContentCharset(
    &self,
    aContentCharset: &mut nsACString
) -> nsresult

/**
     * The character set of the channel's content if available and if applicable.
     * This attribute only applies to textual data.
     *
     * The value of the contentCharset attribute is a mixedcase string.
     */

attribute ACString contentCharset;

pub unsafe fn SetContentCharset(&self, aContentCharset: &nsACString) -> nsresult

/**
     * The character set of the channel's content if available and if applicable.
     * This attribute only applies to textual data.
     *
     * The value of the contentCharset attribute is a mixedcase string.
     */

attribute ACString contentCharset;

pub unsafe fn GetContentLength(&self, aContentLength: *mut int64_t) -> nsresult

/**
     * The length of the data associated with the channel if available.  A value
     * of -1 indicates that the content length is unknown. Note that this is a
     * 64-bit value and obsoletes the "content-length" property used on some
     * channels.
     */

attribute int64_t contentLength;

pub unsafe fn SetContentLength(&self, aContentLength: int64_t) -> nsresult

/**
     * The length of the data associated with the channel if available.  A value
     * of -1 indicates that the content length is unknown. Note that this is a
     * 64-bit value and obsoletes the "content-length" property used on some
     * channels.
     */

attribute int64_t contentLength;

pub unsafe fn Open(&self, _retval: *mut *const nsIInputStream) -> nsresult

/**
     * Synchronously open the channel.
     *
     * @return blocking input stream to the channel's data.
     *
     * NOTE: nsIChannel implementations are not required to implement this
     * method.  Moreover, since this method may block the calling thread, it
     * should not be called on a thread that processes UI events.  Like any
     * other nsIChannel method it must not be called on any thread other
     * than the XPCOM main thread.
     *
     * NOTE: Implementations should throw NS_ERROR_IN_PROGRESS if the channel
     * is reopened.
     */

nsIInputStream open ();

pub unsafe fn Open2(&self, _retval: *mut *const nsIInputStream) -> nsresult

/**
     * Performs content security check and calls open()
     */

nsIInputStream open2 ();

pub unsafe fn AsyncOpen(
    &self,
    aListener: *const nsIStreamListener,
    aContext: *const nsISupports
) -> nsresult

/**
     * Asynchronously open this channel.  Data is fed to the specified stream
     * listener as it becomes available.  The stream listener's methods are
     * called on the thread that calls asyncOpen and are not called until
     * after asyncOpen returns.  If asyncOpen returns successfully, the
     * channel promises to call at least onStartRequest and onStopRequest.
     *
     * If the nsIRequest object passed to the stream listener's methods is not
     * this channel, an appropriate onChannelRedirect notification needs to be
     * sent to the notification callbacks before onStartRequest is called.
     * Once onStartRequest is called, all following method calls on aListener
     * will get the request that was passed to onStartRequest.
     *
     * If the channel's and loadgroup's notification callbacks do not provide
     * an nsIChannelEventSink when onChannelRedirect would be called, that's
     * equivalent to having called onChannelRedirect.
     *
     * If asyncOpen returns successfully, the channel is responsible for
     * keeping itself alive until it has called onStopRequest on aListener or
     * called onChannelRedirect.
     *
     * Implementations are allowed to synchronously add themselves to the
     * associated load group (if any).
     *
     * NOTE: Implementations should throw NS_ERROR_ALREADY_OPENED if the
     * channel is reopened.
     *
     * @param aListener the nsIStreamListener implementation
     * @param aContext an opaque parameter forwarded to aListener's methods
     * @see nsIChannelEventSink for onChannelRedirect
     */

void asyncOpen (in nsIStreamListener aListener, in nsISupports aContext);

pub unsafe fn AsyncOpen2(&self, aListener: *const nsIStreamListener) -> nsresult

/**
     * Performs content security check and calls asyncOpen().
     */

void asyncOpen2 (in nsIStreamListener aListener);

pub unsafe fn GetContentDisposition(
    &self,
    aContentDisposition: *mut uint32_t
) -> nsresult

/**
     * Access to the type implied or stated by the Content-Disposition header
     * if available and if applicable. This allows determining inline versus
     * attachment.
     *
     * Setting contentDisposition provides a hint to the channel about the
     * disposition.  If a normal Content-Disposition header is present its
     * value will always be used.  If it is missing the hinted value will
     * be used if set.
     *
     * Implementations should throw NS_ERROR_NOT_AVAILABLE if the header either
     * doesn't exist for this type of channel or is empty, and return
     * DISPOSITION_ATTACHMENT if an invalid/noncompliant value is present.
     */

attribute unsigned long contentDisposition;

pub unsafe fn SetContentDisposition(
    &self,
    aContentDisposition: uint32_t
) -> nsresult

/**
     * Access to the type implied or stated by the Content-Disposition header
     * if available and if applicable. This allows determining inline versus
     * attachment.
     *
     * Setting contentDisposition provides a hint to the channel about the
     * disposition.  If a normal Content-Disposition header is present its
     * value will always be used.  If it is missing the hinted value will
     * be used if set.
     *
     * Implementations should throw NS_ERROR_NOT_AVAILABLE if the header either
     * doesn't exist for this type of channel or is empty, and return
     * DISPOSITION_ATTACHMENT if an invalid/noncompliant value is present.
     */

attribute unsigned long contentDisposition;

pub unsafe fn GetContentDispositionFilename(
    &self,
    aContentDispositionFilename: &mut nsAString
) -> nsresult

/**
     * Access to the filename portion of the Content-Disposition header if
     * available and if applicable. This allows getting the preferred filename
     * without having to parse it out yourself.
     *
     * Setting contentDispositionFilename provides a hint to the channel about
     * the disposition.  If a normal Content-Disposition header is present its
     * value will always be used.  If it is missing the hinted value will be
     * used if set.
     *
     * Implementations should throw NS_ERROR_NOT_AVAILABLE if the header doesn't
     * exist for this type of channel, if the header is empty, if the header
     * doesn't contain a filename portion, or the value of the filename
     * attribute is empty/missing.
     */

attribute AString contentDispositionFilename;

pub unsafe fn SetContentDispositionFilename(
    &self,
    aContentDispositionFilename: &nsAString
) -> nsresult

/**
     * Access to the filename portion of the Content-Disposition header if
     * available and if applicable. This allows getting the preferred filename
     * without having to parse it out yourself.
     *
     * Setting contentDispositionFilename provides a hint to the channel about
     * the disposition.  If a normal Content-Disposition header is present its
     * value will always be used.  If it is missing the hinted value will be
     * used if set.
     *
     * Implementations should throw NS_ERROR_NOT_AVAILABLE if the header doesn't
     * exist for this type of channel, if the header is empty, if the header
     * doesn't contain a filename portion, or the value of the filename
     * attribute is empty/missing.
     */

attribute AString contentDispositionFilename;

pub unsafe fn GetContentDispositionHeader(
    &self,
    aContentDispositionHeader: &mut nsACString
) -> nsresult

/**
     * Access to the raw Content-Disposition header if available and applicable.
     *
     * Implementations should throw NS_ERROR_NOT_AVAILABLE if the header either
     * doesn't exist for this type of channel or is empty.
     *
     * @deprecated Use contentDisposition/contentDispositionFilename instead.
     */

readonly attribute ACString contentDispositionHeader;

pub unsafe fn GetLoadInfo(&self, aLoadInfo: *mut *const nsILoadInfo) -> nsresult

/**
     * The LoadInfo object contains information about a network load, why it
     * was started, and how we plan on using the resulting response.
     * If a network request is redirected, the new channel will receive a new
     * LoadInfo object. The new object will contain mostly the same
     * information as the pre-redirect one, but updated as appropriate.
     * For detailed information about what parts of LoadInfo are updated on
     * redirect, see documentation on individual properties.
     */

attribute nsILoadInfo loadInfo;

pub unsafe fn SetLoadInfo(&self, aLoadInfo: *const nsILoadInfo) -> nsresult

/**
     * The LoadInfo object contains information about a network load, why it
     * was started, and how we plan on using the resulting response.
     * If a network request is redirected, the new channel will receive a new
     * LoadInfo object. The new object will contain mostly the same
     * information as the pre-redirect one, but updated as appropriate.
     * For detailed information about what parts of LoadInfo are updated on
     * redirect, see documentation on individual properties.
     */

attribute nsILoadInfo loadInfo;

pub unsafe fn GetIsDocument(&self, aIsDocument: *mut bool) -> nsresult

/**
     * Returns true if the channel is used to create a document.
     * It returns true if the loadFlags have LOAD_DOCUMENT_URI set, or if
     * LOAD_HTML_OBJECT_DATA is set and the channel has the appropriate
     * MIME type.
     * Note: May have the wrong value if called before OnStartRequest as we
     * don't know the MIME type yet.
     */

readonly attribute bool isDocument;

Trait Implementations

impl XpCom for nsIWyciwygChannel

const IID: nsIID

IID: nsIID = nsID(2341417793, 18138, 16629, [161, 111, 65, 169, 31, 93, 37, 221])

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 nsIWyciwygChannel

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIWyciwygChannel

type Target = nsIChannel

The resulting type after dereferencing.

fn deref(&self) -> &nsIChannel

Dereferences the value.