Struct xpcom::interfaces::nsIPersistentProperties [] [src]

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

interface nsIPersistentProperties : nsIProperties

Methods

impl nsIPersistentProperties
[src]

[src]

Cast this nsIPersistentProperties to one of its base interfaces.

impl nsIPersistentProperties
[src]

[src]

/**
   * load a set of name/value pairs from the input stream
   * names and values should be in UTF8
   */

void load (in nsIInputStream input);

[src]

/**
   * output the values to the stream - results will be in UTF8
   */

void save (in nsIOutputStream output, in AUTF8String header);

[src]

/**
   * get an enumeration of nsIPropertyElement objects,
   * which are read-only (i.e. setting properties on the element will
   * not make changes back into the source nsIPersistentProperties
   */

nsISimpleEnumerator enumerate ();

[src]

/**
   * shortcut to nsIProperty's get() which retrieves a string value
   * directly (and thus faster)
   */

AString getStringProperty (in AUTF8String key);

[src]

/**
   * shortcut to nsIProperty's set() which sets a string value
   * directly (and thus faster). If the given property already exists,
   * then the old value will be returned
   */

AString setStringProperty (in AUTF8String key, in AString value);

Methods from Deref<Target = nsIProperties>

[src]

Cast this nsIProperties to one of its base interfaces.

[src]

/**
     * Gets a property with a given name.
     *
     * @throws NS_ERROR_FAILURE if a property with that name doesn't exist.
     * @throws NS_ERROR_NO_INTERFACE if the found property fails to QI to the
     * given iid.
     */

void get (in string prop, in nsIIDRef iid, [iid_is (iid), retval] out nsQIResult result);

[src]

/**
     * Sets a property with a given name to a given value.
     */

void set (in string prop, in nsISupports value);

[src]

/**
     * Returns true if the property with the given name exists.
     */

boolean has (in string prop);

[src]

/**
     * Undefines a property.
     * @throws NS_ERROR_FAILURE if a property with that name doesn't
     * already exist.
     */

void undefine (in string prop);

[src]

/**
     *  Returns an array of the keys.
     */

void getKeys (out uint32_t count, [array, size_is (count), retval] out string keys);

Trait Implementations

impl XpCom for nsIPersistentProperties
[src]

IID: nsIID = nsID(1885890479, 1024, 20394, [190, 177, 13, 174, 135, 48, 135, 132])

[src]

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. Read more

impl RefCounted for nsIPersistentProperties
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIPersistentProperties
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.