Struct xpcom::interfaces::mozIStorageValueArray [] [src]

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

interface mozIStorageValueArray : nsISupports

/**
 * mozIStorageValueArray wraps an array of SQL values, such as a single database
 * row.
 */

Methods

impl mozIStorageValueArray
[src]

[src]

Cast this mozIStorageValueArray to one of its base interfaces.

impl mozIStorageValueArray
[src]

VALUE_TYPE_NULL: i64 = 0
/**
   * These type values are returned by getTypeOfIndex
   * to indicate what type of value is present at
   * a given column.
   */

VALUE_TYPE_INTEGER: i64 = 1

VALUE_TYPE_FLOAT: i64 = 2

VALUE_TYPE_TEXT: i64 = 3

VALUE_TYPE_BLOB: i64 = 4

[src]

/**
   * numEntries
   *
   * number of entries in the array (each corresponding to a column
   * in the database row)
   */

readonly attribute unsigned long numEntries;

[src]

/**
   * Returns the type of the value at the given column index;
   * one of VALUE_TYPE_NULL, VALUE_TYPE_INTEGER, VALUE_TYPE_FLOAT,
   * VALUE_TYPE_TEXT, VALUE_TYPE_BLOB.
   */

long getTypeOfIndex (in unsigned long aIndex);

[src]

/**
   * Obtain a value for the given entry (column) index.
   * Due to SQLite's type conversion rules, any of these are valid
   * for any column regardless of the column's data type.  However,
   * if the specific type matters, getTypeOfIndex should be used
   * first to identify the column type, and then the appropriate
   * get method should be called.
   *
   * If you ask for a string value for a NULL column, you will get an empty
   * string with IsVoid set to distinguish it from an explicitly set empty
   * string.
   */

long getInt32 (in unsigned long aIndex);

[src]

long long getInt64 (in unsigned long aIndex);

[src]

double getDouble (in unsigned long aIndex);

[src]

AUTF8String getUTF8String (in unsigned long aIndex);

[src]

AString getString (in unsigned long aIndex);

[src]

void getBlob (in unsigned long aIndex, out unsigned long aDataSize, [array, size_is (aDataSize)] out octet aData);

[src]

AString getBlobAsString (in unsigned long aIndex);

[src]

AUTF8String getBlobAsUTF8String (in unsigned long aIndex);

[src]

boolean getIsNull (in unsigned long aIndex);

[src]

/**
   * Returns a shared string pointer
   */

[noscript] void getSharedUTF8String (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out string aResult);

[src]

[noscript] void getSharedString (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out wstring aResult);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for mozIStorageValueArray
[src]

IID: nsIID = nsID(1851983604, 65447, 16629, [150, 202, 54, 21, 156, 232, 244, 49])

[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 mozIStorageValueArray
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for mozIStorageValueArray
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.