Struct xpcom::interfaces::nsIRefreshURI

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

interface nsIRefreshURI : nsISupports

Methods

impl nsIRefreshURI

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

Cast this nsIRefreshURI to one of its base interfaces.

impl nsIRefreshURI

pub unsafe fn RefreshURI(
    &self,
    aURI: *const nsIURI,
    aPrincipal: *const nsIPrincipal,
    aMillis: int32_t,
    aRepeat: bool,
    aMetaRefresh: bool
) -> nsresult

/**
      * Load a uri after waiting for aMillis milliseconds. If the docshell
      * is busy loading a page currently, the refresh request will be
      * queued and executed when the current load finishes.
      *
      * @param aUri The uri to refresh.
      * @param aPrincipal The triggeringPrincipal for the refresh load
      *   May be null, in which case a principal will be built based on the
      *   referrer URI of the previous docshell load, or will use the system
      *   principal when there is no referrer.
      * @param aMillis The number of milliseconds to wait.
      * @param aRepeat Flag to indicate if the uri is to be
      *                repeatedly refreshed every aMillis milliseconds.
      * @param aMetaRefresh Flag to indicate if this is a Meta refresh.
      */

void refreshURI (in nsIURI aURI, in nsIPrincipal aPrincipal, in long aMillis, in boolean aRepeat, in boolean aMetaRefresh);

pub unsafe fn ForceRefreshURI(
    &self,
    aURI: *const nsIURI,
    aPrincipal: *const nsIPrincipal,
    aMillis: int32_t,
    aMetaRefresh: bool
) -> nsresult

/**
      * Loads a URI immediately as if it were a refresh.
      *
      * @param aURI The URI to refresh.
      * @param aPrincipal The triggeringPrincipal for the refresh load
      *   May be null, in which case a principal will be built based on the
      *   referrer URI of the previous docshell load, or will use the system
      *   principal when there is no referrer.
      * @param aMillis The number of milliseconds by which this refresh would
      *                be delayed if it were not being forced.
      * @param aMetaRefresh Flag to indicate if this is a meta refresh.
      */

void forceRefreshURI (in nsIURI aURI, in nsIPrincipal aPrincipal, in long aMillis, in boolean aMetaRefresh);

pub unsafe fn SetupRefreshURI(&self, aChannel: *const nsIChannel) -> nsresult

/**
      * Checks the passed in channel to see if there is a refresh header,
      * if there is, will setup a timer to refresh the uri found
      * in the header. If docshell is busy loading a page currently, the
      * request will be queued and executed when the current page
      * finishes loading.
      *
      * Returns the NS_REFRESHURI_HEADER_FOUND success code if a refresh
      * header was found and successfully setup.
      *
      * @param aChannel The channel to be parsed.
      */

void setupRefreshURI (in nsIChannel aChannel);

pub unsafe fn SetupRefreshURIFromHeader(
    &self,
    aBaseURI: *const nsIURI,
    principal: *const nsIPrincipal,
    aHeader: &nsACString
) -> nsresult

/**
      * Parses the passed in header string and sets up a refreshURI if
      * a "refresh" header is found. If docshell is busy loading a page
      * currently, the request will be queued and executed when
      * the current page finishes loading.
      *
      * @param aBaseURI base URI to resolve refresh uri with.
      * @param aPrincipal The triggeringPrincipal for the refresh load
      *   May be null, in which case a principal will be built based on the
      *   referrer URI of the previous docshell load, or will use the system
      *   principal when there is no referrer.
      * @param aHeader  The meta refresh header string.
      */

void setupRefreshURIFromHeader (in nsIURI aBaseURI, in nsIPrincipal principal, in ACString aHeader);

pub unsafe fn CancelRefreshURITimers(&self) -> nsresult

/**
      * Cancels all timer loads.
      */

void cancelRefreshURITimers ();

pub unsafe fn GetRefreshPending(&self, aRefreshPending: *mut bool) -> nsresult

/**
     * True when there are pending refreshes, false otherwise.
     */

readonly attribute boolean refreshPending;

Methods from Deref<Target = nsISupports>

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

Cast this nsISupports to one of its base interfaces.

pub unsafe fn QueryInterface(
    &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

[noscript,notxpcom] nsrefcnt AddRef ();

pub unsafe fn Release(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIRefreshURI

const IID: nsIID

IID: nsIID = nsID(2783320636, 20925, 17854, [172, 12, 232, 123, 113, 134, 6, 86])

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 nsIRefreshURI

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIRefreshURI

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.