gecko-dev/toolkit/components/extensions/storage/ExtensionStorageComponents.h
Lina Cambridge 1aa777d5e1 Bug 1626506 - Add a binding for the new extension storage Rust component. r=markh
The `webext_storage_bridge` crate introduced in this commit bridges the
`mozIExtensionStorageArea` XPCOM interface to the `webext_storage` Rust
component from Application Services.

This commit factors out the following parts from bug 1623245, so that
we can land them piecemeal:

* The `mozIExtensionStorageArea` interfaces, which implement all the
  methods needed to support the `storage.sync` API.
* A Rust implementation of the above, in `StorageSyncArea`.
* A `StorageTask` type, for dispatching storage operations to a
  background task queue.
* A `LazyStore`, which wraps the Rust component's `Store` and lazily
  initializes it on the background queue the first time it's used.
* A `StorageSyncService`, which is our singleton. It holds on to a
  configured `StorageSyncArea`, and hands out references to it via
  `getInterface`. Eventually, we'll extend this to support syncing,
  too.

Differential Revision: https://phabricator.services.mozilla.com/D71897
2020-04-27 05:40:54 +00:00

41 lines
1.4 KiB
C++

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_extensions_storage_ExtensionStorageComponents_h_
#define mozilla_extensions_storage_ExtensionStorageComponents_h_
#include "mozIExtensionStorageArea.h"
#include "nsCOMPtr.h"
extern "C" {
// Implemented in Rust, in the `webext_storage_bridge` crate.
nsresult NS_NewExtensionStorageSyncArea(
mozIConfigurableExtensionStorageArea** aResult);
} // extern "C"
namespace mozilla {
namespace extensions {
namespace storage {
// The C++ constructor for a `storage.sync` area. This wrapper exists because
// `components.conf` requires a component class constructor to return an
// `already_AddRefed<T>`, but Rust doesn't have such a type. So we call the
// Rust constructor using a `nsCOMPtr` (which is compatible with Rust's
// `xpcom::RefPtr`) out param, and return that.
already_AddRefed<mozIConfigurableExtensionStorageArea> NewSyncArea() {
nsCOMPtr<mozIConfigurableExtensionStorageArea> storage;
nsresult rv = NS_NewExtensionStorageSyncArea(getter_AddRefs(storage));
if (NS_WARN_IF(NS_FAILED(rv))) {
return nullptr;
}
return storage.forget();
}
} // namespace storage
} // namespace extensions
} // namespace mozilla
#endif // mozilla_extensions_storage_ExtensionStorageComponents_h_