Struct PlacesApi

pub struct PlacesApi { /* private fields */ }

The entry-point to the places API. This object gives access to database connections and other helpers. It enforces that only 1 write connection can exist to the database at once.

Implementations

impl PlacesApi

pub fn new(db_name: impl AsRef<Path>) -> Result<Arc<Self>>

Create a new, or fetch an already open, PlacesApi backed by a file on disk.

pub fn new_memory(db_name: &str) -> Result<Arc<Self>>

Create a new, or fetch an already open, memory-based PlacesApi. You must provide a name, but you are still able to have a single writer and many reader connections to the same memory DB open.

pub fn open_connection(&self, conn_type: ConnectionType) -> Result<PlacesDb>

Open a connection to the database.

pub fn get_sync_connection(&self) -> Result<Arc<SharedPlacesDb>>

pub fn close_connection(&self, connection: PlacesDb) -> Result<()>

Close a connection to the database. If the connection is the write connection, you can re-fetch it using open_connection.

pub fn register_with_sync_manager(self: Arc<Self>)

pub fn sync_history( &self, client_init: &Sync15StorageClientInit, key_bundle: &KeyBundle, ) -> Result<SyncTelemetryPing>

pub fn sync_bookmarks( &self, client_init: &Sync15StorageClientInit, key_bundle: &KeyBundle, ) -> Result<SyncTelemetryPing>

pub fn do_sync_one<F>( &self, name: &'static str, syncer: F, ) -> Result<SyncTelemetryPing>

where F: FnOnce(Arc<SharedPlacesDb>, &mut MemoryCachedState, &mut Option<String>) -> Result<SyncResult>,

pub fn sync( &self, client_init: &Sync15StorageClientInit, key_bundle: &KeyBundle, ) -> Result<SyncResult>

pub fn wipe_bookmarks(&self) -> Result<()>

pub fn reset_bookmarks(&self) -> Result<()>

pub fn reset_history(&self) -> ApiResult<()>

impl PlacesApi

pub fn new_connection( &self, conn_type: ConnectionType, ) -> ApiResult<Arc<PlacesConnection>>

pub fn history_sync( &self, key_id: String, access_token: String, sync_key: String, tokenserver_url: Url, ) -> ApiResult<String>

pub fn bookmarks_sync( &self, key_id: String, access_token: String, sync_key: String, tokenserver_url: Url, ) -> ApiResult<String>

pub fn bookmarks_reset(&self) -> ApiResult<()>

Trait Implementations

impl<UT> LiftRef<UT> for PlacesApi

type LiftType = Arc<PlacesApi>

impl<UT> LowerError<UT> for PlacesApi

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PlacesApi

type ReturnType = <Arc<PlacesApi> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for PlacesApi

const TYPE_ID_META: MetadataBuffer