Struct xpcom::interfaces::mozIStorageVacuumParticipant

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

interface mozIStorageVacuumParticipant : nsISupports

/**
 * This interface contains the information that the Storage service needs to
 * vacuum a database.  This interface is created as a service through the
 * category manager with the category "vacuum-participant".
 * Please see https://developer.mozilla.org/en/mozIStorageVacuumParticipant for
 * more information.
 */

Methods

impl mozIStorageVacuumParticipant

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

Cast this mozIStorageVacuumParticipant to one of its base interfaces.

impl mozIStorageVacuumParticipant

pub unsafe fn GetExpectedDatabasePageSize(
    &self,
    aExpectedDatabasePageSize: *mut int32_t
) -> nsresult

/**
   * The expected page size in bytes for the database.  The vacuum manager will
   * try to correct the page size during idle based on this value.
   *
   * @note If the database is using the WAL journal mode, the page size won't
  *        be changed to the requested value.  See bug 634374.
   * @note Valid page size values are powers of 2 between 512 and 65536.
   *       The suggested value is mozIStorageConnection::defaultPageSize.
   */

readonly attribute long expectedDatabasePageSize;

pub unsafe fn GetDatabaseConnection(
    &self,
    aDatabaseConnection: *mut *const mozIStorageConnection
) -> nsresult

/**
   * Connection to the database file to be vacuumed.
   */

readonly attribute mozIStorageConnection databaseConnection;

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

/**
   * Notifies when a vacuum operation begins.  Listeners should avoid using the
   * database till onEndVacuum is received.
   *
   * @return true to proceed with the vacuum, false if the participant wants to
   *         opt-out for now, it will be retried later.  Useful when participant
   *         is running some other heavy operation that can't be interrupted.
   *
   * @note When a vacuum operation starts or ends it will also dispatch a global
   *       "heavy-io-task" notification through the observer service with the
   *       data argument being either "vacuum-begin" or "vacuum-end".
   */

boolean onBeginVacuum ();

pub unsafe fn OnEndVacuum(&self, aSucceeded: bool) -> nsresult

/**
   * Notifies when a vacuum operation ends.
   *
   * @param aSucceeded
   *        reports if the vacuum succeeded or failed.
   */

void onEndVacuum (in boolean aSucceeded);

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 mozIStorageVacuumParticipant

const IID: nsIID

IID: nsIID = nsID(2402710792, 7578, 19775, [190, 12, 172, 17, 182, 221, 125, 191])

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 mozIStorageVacuumParticipant

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for mozIStorageVacuumParticipant

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.