Struct xpcom::interfaces::nsICacheService

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

interface nsICacheService : nsISupports

/**
 * @deprecated
 *
 * IMPORTANT NOTE: THIS INTERFACE IS NO LONGER SUPPORTED AND PLANNED TO BE
 * REMOVED SOON. WE STRONGLY ENCORAGE TO MIGRATE THE EXISTING CODE AND FOR
 * THE NEW CODE USE ONLY THE NEW HTTP CACHE API IN netwerk/cache2/.
 */

Methods

impl nsICacheService

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

Cast this nsICacheService to one of its base interfaces.

impl nsICacheService

pub unsafe fn CreateSession(
    &self,
    clientID: *const c_char,
    storagePolicy: nsCacheStoragePolicy,
    streamBased: bool,
    _retval: *mut *const nsICacheSession
) -> nsresult

/**
     * @throws NS_ERROR_NOT_IMPLEMENTED when the cache v2 is prefered to use.
     *
     * Create a cache session
     *
     * A cache session represents a client's access into the cache.  The cache
     * session is not "owned" by the cache service.  Hence, it is possible to
     * create duplicate cache sessions.  Entries created by a cache session
     * are invisible to other cache sessions, unless the cache sessions are
     * equivalent.
     *
     * @param clientID - Specifies the name of the client using the cache.
     * @param storagePolicy - Limits the storage policy for all entries
     *   accessed via the returned session.  As a result, devices excluded
     *   by the storage policy will not be searched when opening entries
     *   from the returned session.
     * @param streamBased - Indicates whether or not the data being cached
     *   can be represented as a stream.  The storagePolicy must be
     *   consistent with the value of this field.  For example, a non-stream-
     *   based cache entry can only have a storage policy of STORE_IN_MEMORY.
     * @return new cache session.
     */

nsICacheSession createSession (in string clientID, in nsCacheStoragePolicy storagePolicy, in boolean streamBased);

pub unsafe fn VisitEntries(&self, visitor: *const nsICacheVisitor) -> nsresult

/**
     * @throws NS_ERROR_NOT_IMPLEMENTED when the cache v2 is prefered to use.
     *
     * Visit entries stored in the cache.  Used to implement about:cache.
     */

void visitEntries (in nsICacheVisitor visitor);

pub unsafe fn EvictEntries(
    &self,
    storagePolicy: nsCacheStoragePolicy
) -> nsresult

/**
     * @throws NS_ERROR_NOT_IMPLEMENTED when the cache v2 is prefered to use.
     *
     * Evicts all entries in all devices implied by the storage policy.
     *
     * @note This function may evict some items but will throw if it fails to evict
     *       everything.
     */

void evictEntries (in nsCacheStoragePolicy storagePolicy);

pub unsafe fn GetCacheIOTarget(
    &self,
    aCacheIOTarget: *mut *const nsIEventTarget
) -> nsresult

/**
     * Event target which is used for I/O operations
     */

readonly attribute nsIEventTarget cacheIOTarget;

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 nsICacheService

const IID: nsIID

IID: nsIID = nsID(349954537, 62396, 17839, [146, 244, 44, 87, 79, 205, 78, 57])

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 nsICacheService

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsICacheService

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.