Struct xpcom::interfaces::nsIPrivateBrowsingChannel

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

interface nsIPrivateBrowsingChannel : nsISupports

/**
 * This interface is implemented by channels which support overriding the
 * privacy state of the channel.
 *
 * This interface must be used only from the XPCOM main thread.
 */

Methods

impl nsIPrivateBrowsingChannel

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

Cast this nsIPrivateBrowsingChannel to one of its base interfaces.

impl nsIPrivateBrowsingChannel

pub unsafe fn SetPrivate(&self, aPrivate: bool) -> nsresult

/**
     * Determine whether the channel is tied to a private browsing window.
     *
     * This value can be set only before the channel is opened.  Setting it
     * after that does not have any effect.  This value overrides the privacy
     * state of the channel, which means that if you call this method, then
     * the loadGroup and load context will no longer be consulted when we
     * need to know the private mode status for a channel.
     *
     * Note that this value is only meant to be used when the channel's privacy
     * status cannot be obtained from the loadGroup or load context (for
     * example, when the channel is not associated with any loadGroup or load
     * context.)  Setting this value directly should be avoided if possible.
     *
     * Implementations must enforce the ordering semantics of this function by
     * raising errors if setPrivate is called on a channel which has a loadGroup
     * and/or callbacks that implement nsILoadContext, or if the loadGroup
     * or notificationCallbacks are set after setPrivate has been called.
     *
     * @param aPrivate whether the channel should be opened in private mode.
     */

void setPrivate (in boolean aPrivate);

pub unsafe fn GetIsChannelPrivate(
    &self,
    aIsChannelPrivate: *mut bool
) -> nsresult

/**
     * States whether the channel is in private browsing mode. This may either
     * happen because the channel is opened from a private mode context or
     * when the mode is explicitly set with ::setPrivate().
     *
     * This attribute is equivalent to NS_UsePrivateBrowsing(), but scriptable.
     */

readonly attribute boolean isChannelPrivate;

pub unsafe fn IsPrivateModeOverriden(
    &self,
    aValue: *mut bool,
    _retval: *mut bool
) -> nsresult

[noscript] boolean isPrivateModeOverriden (out boolean aValue);

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 nsIPrivateBrowsingChannel

const IID: nsIID

IID: nsIID = nsID(3748670384, 21944, 4578, [188, 253, 8, 0, 32, 12, 154, 102])

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 nsIPrivateBrowsingChannel

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIPrivateBrowsingChannel

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.