kotlin-components-docs/mozilla.appservices.places.uniffi

Package-level declarations

Types

data class BookmarkData(var guid: Guid, var parentGuid: Guid, var position: UInt, var dateAdded: PlacesTimestamp, var lastModified: PlacesTimestamp, var url: Url, var title: String?)

BookmarkFolder

data class BookmarkFolder(var guid: Guid, var dateAdded: PlacesTimestamp, var lastModified: PlacesTimestamp, var parentGuid: Guid?, var position: UInt, var title: String?, var childGuids: List<Guid>?, var childNodes: List<BookmarkItem>?)

BookmarkItem

sealed class BookmarkItem

BookmarkPosition

sealed class BookmarkPosition

Where the item should be placed.

BookmarkSeparator

data class BookmarkSeparator(var guid: Guid, var dateAdded: PlacesTimestamp, var lastModified: PlacesTimestamp, var parentGuid: Guid, var position: UInt)

BookmarkUpdateInfo

data class BookmarkUpdateInfo(var guid: Guid, var title: String?, var url: String?, var parentGuid: Guid?, var position: UInt?)

ConnectionType

enum ConnectionType : Enum<ConnectionType>

Disposable

interface Disposable

DocumentType

enum DocumentType : Enum<DocumentType>

Dummy

data class Dummy(var md: List<HistoryMetadata>?)

Exists just to convince uniffi to generate liftSequence* helpers!

FfiConverter

interface FfiConverter<KotlinType, FfiType>

FfiConverterBoolean

object FfiConverterBoolean : FfiConverter<Boolean, Byte>

FfiConverterDouble

object FfiConverterDouble : FfiConverter<Double, Double>

FfiConverterInt

object FfiConverterInt : FfiConverter<Int, Int>

FfiConverterLong

object FfiConverterLong : FfiConverter<Long, Long>

FfiConverterOptionalBoolean

object FfiConverterOptionalBoolean : FfiConverterRustBuffer<Boolean?>

FfiConverterOptionalInt

object FfiConverterOptionalInt : FfiConverterRustBuffer<Int?>

FfiConverterOptionalSequenceTypeBookmarkItem

object FfiConverterOptionalSequenceTypeBookmarkItem : FfiConverterRustBuffer<List<BookmarkItem>?>

FfiConverterOptionalSequenceTypeGuid

object FfiConverterOptionalSequenceTypeGuid : FfiConverterRustBuffer<List<Guid>?>

FfiConverterOptionalSequenceTypeHistoryMetadata

object FfiConverterOptionalSequenceTypeHistoryMetadata : FfiConverterRustBuffer<List<HistoryMetadata>?>

FfiConverterOptionalString

object FfiConverterOptionalString : FfiConverterRustBuffer<String?>

FfiConverterOptionalTypeBookmarkItem

object FfiConverterOptionalTypeBookmarkItem : FfiConverterRustBuffer<BookmarkItem?>

FfiConverterOptionalTypeDocumentType

object FfiConverterOptionalTypeDocumentType : FfiConverterRustBuffer<DocumentType?>

FfiConverterOptionalTypeGuid

object FfiConverterOptionalTypeGuid : FfiConverterRustBuffer<Guid?>

FfiConverterOptionalTypeHistoryMetadata

object FfiConverterOptionalTypeHistoryMetadata : FfiConverterRustBuffer<HistoryMetadata?>

FfiConverterOptionalTypePlacesTimestamp

object FfiConverterOptionalTypePlacesTimestamp : FfiConverterRustBuffer<PlacesTimestamp?>

FfiConverterOptionalTypeUrl

object FfiConverterOptionalTypeUrl : FfiConverterRustBuffer<Url?>

FfiConverterOptionalTypeVisitType

object FfiConverterOptionalTypeVisitType : FfiConverterRustBuffer<VisitType?>

FfiConverterOptionalUInt

object FfiConverterOptionalUInt : FfiConverterRustBuffer<UInt?>

FfiConverterRustBuffer

interface FfiConverterRustBuffer<KotlinType> : FfiConverter<KotlinType, RustBuffer.ByValue>

FfiConverterSequenceBoolean

object FfiConverterSequenceBoolean : FfiConverterRustBuffer<List<Boolean>>

FfiConverterSequenceString

object FfiConverterSequenceString : FfiConverterRustBuffer<List<String>>

FfiConverterSequenceTypeBookmarkItem

object FfiConverterSequenceTypeBookmarkItem : FfiConverterRustBuffer<List<BookmarkItem>>

FfiConverterSequenceTypeGuid

object FfiConverterSequenceTypeGuid : FfiConverterRustBuffer<List<Guid>>

FfiConverterSequenceTypeHistoryHighlight

object FfiConverterSequenceTypeHistoryHighlight : FfiConverterRustBuffer<List<HistoryHighlight>>

FfiConverterSequenceTypeHistoryMetadata

object FfiConverterSequenceTypeHistoryMetadata : FfiConverterRustBuffer<List<HistoryMetadata>>

FfiConverterSequenceTypeHistoryVisitInfo

object FfiConverterSequenceTypeHistoryVisitInfo : FfiConverterRustBuffer<List<HistoryVisitInfo>>

FfiConverterSequenceTypeInsertableBookmarkItem

object FfiConverterSequenceTypeInsertableBookmarkItem : FfiConverterRustBuffer<List<InsertableBookmarkItem>>

FfiConverterSequenceTypeSearchResult

object FfiConverterSequenceTypeSearchResult : FfiConverterRustBuffer<List<SearchResult>>

FfiConverterSequenceTypeTopFrecentSiteInfo

object FfiConverterSequenceTypeTopFrecentSiteInfo : FfiConverterRustBuffer<List<TopFrecentSiteInfo>>

FfiConverterSequenceTypeUrl

object FfiConverterSequenceTypeUrl : FfiConverterRustBuffer<List<Url>>

FfiConverterString

object FfiConverterString : FfiConverter<String, RustBuffer.ByValue>

FfiConverterTypeBookmarkData

object FfiConverterTypeBookmarkData : FfiConverterRustBuffer<BookmarkData>

FfiConverterTypeBookmarkFolder

object FfiConverterTypeBookmarkFolder : FfiConverterRustBuffer<BookmarkFolder>

FfiConverterTypeBookmarkItem

object FfiConverterTypeBookmarkItem : FfiConverterRustBuffer<BookmarkItem>

FfiConverterTypeBookmarkPosition

object FfiConverterTypeBookmarkPosition : FfiConverterRustBuffer<BookmarkPosition>

FfiConverterTypeBookmarkSeparator

object FfiConverterTypeBookmarkSeparator : FfiConverterRustBuffer<BookmarkSeparator>

FfiConverterTypeBookmarkUpdateInfo

object FfiConverterTypeBookmarkUpdateInfo : FfiConverterRustBuffer<BookmarkUpdateInfo>

FfiConverterTypeConnectionType

object FfiConverterTypeConnectionType : FfiConverterRustBuffer<ConnectionType>

FfiConverterTypeDocumentType

object FfiConverterTypeDocumentType : FfiConverterRustBuffer<DocumentType>

FfiConverterTypeDummy

object FfiConverterTypeDummy : FfiConverterRustBuffer<Dummy>

FfiConverterTypeFrecencyThresholdOption

object FfiConverterTypeFrecencyThresholdOption : FfiConverterRustBuffer<FrecencyThresholdOption>

FfiConverterTypeGuid

typealias FfiConverterTypeGuid = FfiConverterString

FfiConverterTypeHistoryHighlight

object FfiConverterTypeHistoryHighlight : FfiConverterRustBuffer<HistoryHighlight>

FfiConverterTypeHistoryHighlightWeights

object FfiConverterTypeHistoryHighlightWeights : FfiConverterRustBuffer<HistoryHighlightWeights>

FfiConverterTypeHistoryMetadata

object FfiConverterTypeHistoryMetadata : FfiConverterRustBuffer<HistoryMetadata>

FfiConverterTypeHistoryMetadataObservation

object FfiConverterTypeHistoryMetadataObservation : FfiConverterRustBuffer<HistoryMetadataObservation>

FfiConverterTypeHistoryMigrationResult

object FfiConverterTypeHistoryMigrationResult : FfiConverterRustBuffer<HistoryMigrationResult>

FfiConverterTypeHistoryVisitInfo

object FfiConverterTypeHistoryVisitInfo : FfiConverterRustBuffer<HistoryVisitInfo>

FfiConverterTypeHistoryVisitInfosWithBound

object FfiConverterTypeHistoryVisitInfosWithBound : FfiConverterRustBuffer<HistoryVisitInfosWithBound>

FfiConverterTypeInsertableBookmark

object FfiConverterTypeInsertableBookmark : FfiConverterRustBuffer<InsertableBookmark>

FfiConverterTypeInsertableBookmarkFolder

object FfiConverterTypeInsertableBookmarkFolder : FfiConverterRustBuffer<InsertableBookmarkFolder>

FfiConverterTypeInsertableBookmarkItem

object FfiConverterTypeInsertableBookmarkItem : FfiConverterRustBuffer<InsertableBookmarkItem>

FfiConverterTypeInsertableBookmarkSeparator

object FfiConverterTypeInsertableBookmarkSeparator : FfiConverterRustBuffer<InsertableBookmarkSeparator>

FfiConverterTypePlacesApi

object FfiConverterTypePlacesApi : FfiConverter<PlacesApi, <Error class: unknown class>>

FfiConverterTypePlacesApiError

object FfiConverterTypePlacesApiError : FfiConverterRustBuffer<PlacesApiException>

FfiConverterTypePlacesConnection

object FfiConverterTypePlacesConnection : FfiConverter<PlacesConnection, <Error class: unknown class>>

FfiConverterTypePlacesTimestamp

typealias FfiConverterTypePlacesTimestamp = FfiConverterLong

FfiConverterTypeRunMaintenanceMetrics

object FfiConverterTypeRunMaintenanceMetrics : FfiConverterRustBuffer<RunMaintenanceMetrics>

FfiConverterTypeSearchResult

object FfiConverterTypeSearchResult : FfiConverterRustBuffer<SearchResult>

FfiConverterTypeSqlInterruptHandle

object FfiConverterTypeSqlInterruptHandle : FfiConverter<SqlInterruptHandle, <Error class: unknown class>>

FfiConverterTypeTopFrecentSiteInfo

object FfiConverterTypeTopFrecentSiteInfo : FfiConverterRustBuffer<TopFrecentSiteInfo>

FfiConverterTypeUrl

typealias FfiConverterTypeUrl = FfiConverterString

FfiConverterTypeVisitObservation

object FfiConverterTypeVisitObservation : FfiConverterRustBuffer<VisitObservation>

FfiConverterTypeVisitTransitionSet

typealias FfiConverterTypeVisitTransitionSet = FfiConverterInt

FfiConverterTypeVisitType

object FfiConverterTypeVisitType : FfiConverterRustBuffer<VisitType>

FfiConverterUInt

object FfiConverterUInt : FfiConverter<UInt, Int>

FfiConverterULong

object FfiConverterULong : FfiConverter<ULong, Long>

ForeignBytes

open class ForeignBytes

FrecencyThresholdOption

enum FrecencyThresholdOption : Enum<FrecencyThresholdOption>

Frecency threshold options for fetching top frecent sites. Requests a page that was visited with a frecency score greater or equal to the value associated with the enums

Guid

typealias Guid = String

Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures. It's also what we have an external type that references a custom type.

HistoryHighlight

data class HistoryHighlight(var score: Double, var placeId: Int, var url: String, var title: String?, var previewImageUrl: String?)

HistoryHighlightWeights

data class HistoryHighlightWeights(var viewTime: Double, var frequency: Double)

HistoryMetadata

data class HistoryMetadata(var url: String, var title: String?, var previewImageUrl: String?, var createdAt: Long, var updatedAt: Long, var totalViewTime: Int, var searchTerm: String?, var documentType: DocumentType, var referrerUrl: String?)

This is what is returned.

HistoryMetadataObservation

data class HistoryMetadataObservation(var url: String, var referrerUrl: String? = null, var searchTerm: String? = null, var viewTime: Int? = null, var documentType: DocumentType? = null, var title: String? = null)

This is used as an "input" to the api.

HistoryMigrationResult

data class HistoryMigrationResult(var numTotal: UInt, var numSucceeded: UInt, var numFailed: UInt, var totalDuration: ULong)

HistoryVisitInfo

data class HistoryVisitInfo(var url: Url, var title: String?, var timestamp: PlacesTimestamp, var visitType: VisitType, var isHidden: Boolean, var previewImageUrl: Url?, var isRemote: Boolean)

HistoryVisitInfosWithBound

data class HistoryVisitInfosWithBound(var infos: List<HistoryVisitInfo>, var bound: Long, var offset: Long)

InsertableBookmark

data class InsertableBookmark(var guid: Guid? = null, var parentGuid: Guid, var position: BookmarkPosition, var dateAdded: PlacesTimestamp? = null, var lastModified: PlacesTimestamp? = null, var url: Url, var title: String? = null)

InsertableBookmarkFolder

data class InsertableBookmarkFolder(var guid: Guid? = null, var parentGuid: Guid, var position: BookmarkPosition, var dateAdded: PlacesTimestamp? = null, var lastModified: PlacesTimestamp? = null, var title: String? = null, var children: List<InsertableBookmarkItem>)

InsertableBookmarkItem

sealed class InsertableBookmarkItem

InsertableBookmarkSeparator

data class InsertableBookmarkSeparator(var guid: Guid? = null, var parentGuid: Guid, var position: BookmarkPosition, var dateAdded: PlacesTimestamp? = null, var lastModified: PlacesTimestamp? = null)

InternalException

class InternalException(message: String) : Exception

NoPointer

object NoPointer

Used to instantiate an interface without an actual pointer, for fakes in tests, mostly.

PlacesApi

open class PlacesApi : Disposable, AutoCloseable, PlacesApiInterface

PlacesApiException

sealed class PlacesApiException : Exception

PlacesApiInterface

interface PlacesApiInterface

PlacesConnection

open class PlacesConnection : Disposable, AutoCloseable, PlacesConnectionInterface

PlacesConnectionInterface

interface PlacesConnectionInterface

PlacesTimestamp

typealias PlacesTimestamp = Long

RunMaintenanceMetrics

data class RunMaintenanceMetrics(var prunedVisits: Boolean, var dbSizeBefore: UInt, var dbSizeAfter: UInt)

RustBuffer

open class RustBuffer

RustBufferByReference

class RustBufferByReference

The equivalent of the *mut RustBuffer type. Required for callbacks taking in an out pointer.

SearchResult

data class SearchResult(var url: Url, var title: String, var frecency: Long)

SqlInterruptHandle

open class SqlInterruptHandle : Disposable, AutoCloseable, SqlInterruptHandleInterface

SqlInterruptHandleInterface

interface SqlInterruptHandleInterface

TopFrecentSiteInfo

data class TopFrecentSiteInfo(var url: Url, var title: String?)

UniffiCleaner

interface UniffiCleaner

UniffiNullRustCallStatusErrorHandler

object UniffiNullRustCallStatusErrorHandler : UniffiRustCallStatusErrorHandler<InternalException>

UniffiRustCallStatusErrorHandler

interface UniffiRustCallStatusErrorHandler<E>

Url

typealias Url = String

VisitObservation

data class VisitObservation(var url: Url, var title: String? = null, var visitType: VisitType?, var isError: Boolean? = null, var isRedirectSource: Boolean? = null, var isPermanentRedirectSource: Boolean? = null, var at: PlacesTimestamp? = null, var referrer: Url? = null, var isRemote: Boolean? = null, var previewImageUrl: Url? = null)

Encapsulates either information about a visit to a page, or meta information about the page, or both. Use VisitType.UPDATE_PLACE to differentiate an update from a visit.

VisitTransitionSet

typealias VisitTransitionSet = Int

VisitType

enum VisitType : Enum<VisitType>

Functions

placesApiNew

fun placesApiNew(dbPath: String): PlacesApi

use

inline fun <T : Disposable?, R> T.use(block: (T) -> R): R