Struct xpcom::interfaces::nsIContentPrefService2

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

interface nsIContentPrefService2 : nsISupports

/**
 * Content Preferences
 *
 * Content preferences allow the application to associate arbitrary data, or
 * "preferences", with specific domains, or web "content".  Specifically, a
 * content preference is a structure with three values: a domain with which the
 * preference is associated, a name that identifies the preference within its
 * domain, and a value.  (See nsIContentPref below.)
 *
 * For example, if you want to remember the user's preference for a certain zoom
 * level on www.mozilla.org pages, you might store a preference whose domain is
 * "www.mozilla.org", whose name is "zoomLevel", and whose value is the numeric
 * zoom level.
 *
 * A preference need not have a domain, and in that case the preference is
 * called a "global" preference.  This interface doesn't impart any special
 * significance to global preferences; they're simply name-value pairs that
 * aren't associated with any particular domain.  As a consumer of this
 * interface, you might choose to let a global preference override all non-
 * global preferences of the same name, for example, for whatever definition of
 * "override" is appropriate for your use case.
 *
 *
 * Domain Parameters
 *
 * Many methods of this interface accept a "domain" parameter.  Domains may be
 * specified either exactly, like "example.com", or as full URLs, like
 * "http://example.com/foo/bar".  In the latter case the API extracts the full
 * domain from the URL, so if you specify "http://foo.bar.example.com/baz", the
 * domain is taken to be "foo.bar.example.com", not "example.com".
 *
 *
 * Private-Browsing Context Parameters
 *
 * Many methods also accept a "context" parameter.  This parameter relates to
 * private browsing and determines the kind of storage that a method uses,
 * either the usual permanent storage or temporary storage set aside for private
 * browsing sessions.
 *
 * Pass null to unconditionally use permanent storage.  Pass an nsILoadContext
 * to use storage appropriate to the context's usePrivateBrowsing attribute: if
 * usePrivateBrowsing is true, temporary private-browsing storage is used, and
 * otherwise permanent storage is used.  A context can be obtained from the
 * window or channel whose content pertains to the preferences being modified or
 * retrieved.
 *
 *
 * Callbacks
 *
 * The methods of callback objects are always called asynchronously.
 *
 * Observers are called after callbacks are called, but they are called in the
 * same turn of the event loop as callbacks.
 *
 * See nsIContentPrefCallback2 below for more information about callbacks.
 */

Methods

impl nsIContentPrefService2

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

Cast this nsIContentPrefService2 to one of its base interfaces.

impl nsIContentPrefService2

pub unsafe fn GetByName(
    &self,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Gets all the preferences with the given name.
   *
   * @param name      The preferences' name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleResult is called once for each preference unless
   *                  no such preferences exist, in which case handleResult
   *                  is not called at all.
   */

void getByName (in AString name, in nsILoadContext context, in nsIContentPrefCallback2 callback);

pub unsafe fn GetByDomainAndName(
    &self,
    domain: &nsAString,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Gets the preference with the given domain and name.
   *
   * @param domain    The preference's domain.
   * @param name      The preference's name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleResult is called once unless no such preference
   *                  exists, in which case handleResult is not called at all.
   */

void getByDomainAndName (in AString domain, in AString name, in nsILoadContext context, in nsIContentPrefCallback2 callback);

pub unsafe fn GetBySubdomainAndName(
    &self,
    domain: &nsAString,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Gets all preferences with the given name whose domains are either the same
   * as or subdomains of the given domain.
   *
   * @param domain    The preferences' domain.
   * @param name      The preferences' name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleResult is called once for each preference.  If no
   *                  such preferences exist, handleResult is not called at all.
   */

void getBySubdomainAndName (in AString domain, in AString name, in nsILoadContext context, in nsIContentPrefCallback2 callback);

pub unsafe fn GetGlobal(
    &self,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Gets the preference with no domain and the given name.
   *
   * @param name      The preference's name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleResult is called once unless no such preference
   *                  exists, in which case handleResult is not called at all.
   */

void getGlobal (in AString name, in nsILoadContext context, in nsIContentPrefCallback2 callback);

pub unsafe fn GetCachedByDomainAndName(
    &self,
    domain: &nsAString,
    name: &nsAString,
    context: *const nsILoadContext,
    _retval: *mut *const nsIContentPref
) -> nsresult

/**
   * Synchronously retrieves from the in-memory cache the preference with the
   * given domain and name.
   *
   * In addition to caching preference values, the cache also keeps track of
   * preferences that are known not to exist.  If the preference is known not to
   * exist, the value attribute of the returned object will be undefined
   * (nsIDataType::VTYPE_VOID).
   *
   * If the preference is neither cached nor known not to exist, then null is
   * returned, and get() must be called to determine whether the preference
   * exists.
   *
   * @param domain   The preference's domain.
   * @param name     The preference's name.
   * @param context  The private-browsing context, if any.
   * @return         The preference, or null if no such preference is known to
   *                 exist.
   */

nsIContentPref getCachedByDomainAndName (in AString domain, in AString name, in nsILoadContext context);

pub unsafe fn GetCachedBySubdomainAndName(
    &self,
    domain: &nsAString,
    name: &nsAString,
    context: *const nsILoadContext,
    len: *mut uint32_t,
    prefs: *mut *mut *const nsIContentPref
) -> nsresult

/**
   * Synchronously retrieves from the in-memory cache all preferences with the
   * given name whose domains are either the same as or subdomains of the given
   * domain.
   *
   * The preferences are returned in an array through the out-parameter.  If a
   * preference for a particular subdomain is known not to exist, then an object
   * corresponding to that preference will be present in the array, and, as with
   * getCachedByDomainAndName, its value attribute will be undefined.
   *
   * @param domain   The preferences' domain.
   * @param name     The preferences' name.
   * @param context  The private-browsing context, if any.
   * @param len      The length of the returned array.
   * @param prefs    The array of preferences.
   */

void getCachedBySubdomainAndName (in AString domain, in AString name, in nsILoadContext context, [optional] out unsigned long len, [array, size_is (len), retval] out nsIContentPref prefs);

pub unsafe fn GetCachedGlobal(
    &self,
    name: &nsAString,
    context: *const nsILoadContext,
    _retval: *mut *const nsIContentPref
) -> nsresult

/**
   * Synchronously retrieves from the in-memory cache the preference with no
   * domain and the given name.
   *
   * As with getCachedByDomainAndName, if the preference is cached then it is
   * returned; if the preference is known not to exist, then the value attribute
   * of the returned object will be undefined; if the preference is neither
   * cached nor known not to exist, then null is returned.
   *
   * @param name     The preference's name.
   * @param context  The private-browsing context, if any.
   * @return         The preference, or null if no such preference is known to
   *                 exist.
   */

nsIContentPref getCachedGlobal (in AString name, in nsILoadContext context);

pub unsafe fn Set(
    &self,
    domain: &nsAString,
    name: &nsAString,
    value: *const nsIVariant,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Sets a preference.
   *
   * @param domain    The preference's domain.
   * @param name      The preference's name.
   * @param value     The preference's value.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the preference has been
   *                  stored.
   */

void set (in AString domain, in AString name, in nsIVariant value, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn SetGlobal(
    &self,
    name: &nsAString,
    value: *const nsIVariant,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Sets a preference with no domain.
   *
   * @param name      The preference's name.
   * @param value     The preference's value.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the preference has been
   *                  stored.
   */

void setGlobal (in AString name, in nsIVariant value, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveByDomainAndName(
    &self,
    domain: &nsAString,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes the preference with the given domain and name.
   *
   * @param domain    The preference's domain.
   * @param name      The preference's name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeByDomainAndName (in AString domain, in AString name, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveBySubdomainAndName(
    &self,
    domain: &nsAString,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all the preferences with the given name whose domains are either
   * the same as or subdomains of the given domain.
   *
   * @param domain    The preferences' domain.
   * @param name      The preferences' name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeBySubdomainAndName (in AString domain, in AString name, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveGlobal(
    &self,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes the preference with no domain and the given name.
   *
   * @param name      The preference's name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeGlobal (in AString name, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveByDomain(
    &self,
    domain: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all preferences with the given domain.
   *
   * @param domain    The preferences' domain.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeByDomain (in AString domain, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveBySubdomain(
    &self,
    domain: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all preferences whose domains are either the same as or subdomains
   * of the given domain.
   *
   * @param domain    The preferences' domain.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeBySubdomain (in AString domain, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveByName(
    &self,
    name: &nsAString,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all preferences with the given name regardless of domain, including
   * global preferences with the given name.
   *
   * @param name      The preferences' name.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeByName (in AString name, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveAllDomains(
    &self,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all non-global preferences -- in other words, all preferences that
   * have a domain.
   *
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeAllDomains (in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveAllDomainsSince(
    &self,
    since: uint64_t,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all non-global preferences created after and including |since|.
   *
   * @param since     Timestamp in milliseconds.
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeAllDomainsSince (in unsigned long long since, in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn RemoveAllGlobals(
    &self,
    context: *const nsILoadContext,
    callback: *const nsIContentPrefCallback2
) -> nsresult

/**
   * Removes all global preferences -- in other words, all preferences that have
   * no domain.
   *
   * @param context   The private-browsing context, if any.
   * @param callback  handleCompletion is called when the operation completes.
   */

void removeAllGlobals (in nsILoadContext context, [optional] in nsIContentPrefCallback2 callback);

pub unsafe fn AddObserverForName(
    &self,
    name: &nsAString,
    observer: *const nsIContentPrefObserver
) -> nsresult

/**
   * Registers an observer that will be notified whenever a preference with the
   * given name is set or removed.
   *
   * When a set or remove method is called, observers are called after the set
   * or removal completes and after the method's callback is called, and they
   * are called in the same turn of the event loop as the callback.
   *
   * The service holds a strong reference to the observer, so the observer must
   * be removed later to avoid leaking it.
   *
   * @param name      The name of the preferences to observe.  Pass null to
   *                  observe all preference changes regardless of name.
   * @param observer  The observer.
   */

void addObserverForName (in AString name, in nsIContentPrefObserver observer);

pub unsafe fn RemoveObserverForName(
    &self,
    name: &nsAString,
    observer: *const nsIContentPrefObserver
) -> nsresult

/**
   * Unregisters an observer for the given name.
   *
   * @param name      The name for which the observer was registered.  Pass null
   *                  if the observer was added with a null name.
   * @param observer  The observer.
   */

void removeObserverForName (in AString name, in nsIContentPrefObserver observer);

pub unsafe fn ExtractDomain(
    &self,
    str: &nsAString,
    _retval: &mut nsAString
) -> nsresult

/**
   * Extracts and returns the domain from the given string representation of a
   * URI.  This is how the API extracts domains from URIs passed to it.
   *
   * @param str  The string representation of a URI, like
   *             "http://example.com/foo/bar".
   * @return     If the given string is a valid URI, the domain of that URI is
   *             returned.  Otherwise, the string itself is returned.
   */

AString extractDomain (in AString str);

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 nsIContentPrefService2

const IID: nsIID

IID: nsIID = nsID(3201926758, 55701, 18191, [190, 189, 98, 71, 109, 49, 133, 118])

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 nsIContentPrefService2

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIContentPrefService2

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.