kotlin-components-docs/mozilla.appservices.suggest

Package-level declarations

Types

interface Disposable

interface FfiConverter<KotlinType, FfiType>

FfiConverterBoolean

object FfiConverterBoolean : FfiConverter<Boolean, Byte>

FfiConverterByteArray

object FfiConverterByteArray : FfiConverterRustBuffer<ByteArray>

FfiConverterDouble

object FfiConverterDouble : FfiConverter<Double, Double>

FfiConverterInt

object FfiConverterInt : FfiConverter<Int, Int>

FfiConverterLong

object FfiConverterLong : FfiConverter<Long, Long>

FfiConverterOptionalByteArray

object FfiConverterOptionalByteArray : FfiConverterRustBuffer<ByteArray?>

FfiConverterOptionalInt

object FfiConverterOptionalInt : FfiConverterRustBuffer<Int?>

FfiConverterOptionalSequenceString

object FfiConverterOptionalSequenceString : FfiConverterRustBuffer<List<String>?>

FfiConverterOptionalSequenceTypeSuggestionProvider

object FfiConverterOptionalSequenceTypeSuggestionProvider : FfiConverterRustBuffer<List<SuggestionProvider>?>

FfiConverterOptionalString

object FfiConverterOptionalString : FfiConverterRustBuffer<String?>

FfiConverterOptionalTypeInterruptKind

object FfiConverterOptionalTypeInterruptKind : FfiConverterRustBuffer<InterruptKind?>

FfiConverterOptionalTypeRemoteSettingsConfig

object FfiConverterOptionalTypeRemoteSettingsConfig : FfiConverterRustBuffer<RemoteSettingsConfig?>

FfiConverterOptionalTypeSuggestionProviderConstraints

object FfiConverterOptionalTypeSuggestionProviderConstraints : FfiConverterRustBuffer<SuggestionProviderConstraints?>

FfiConverterOptionalTypeSuggestProviderConfig

object FfiConverterOptionalTypeSuggestProviderConfig : FfiConverterRustBuffer<SuggestProviderConfig?>

FfiConverterRustBuffer

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

FfiConverterSequenceString

object FfiConverterSequenceString : FfiConverterRustBuffer<List<String>>

FfiConverterSequenceTypeLabeledTimingSample

object FfiConverterSequenceTypeLabeledTimingSample : FfiConverterRustBuffer<List<LabeledTimingSample>>

FfiConverterSequenceTypeSuggestion

object FfiConverterSequenceTypeSuggestion : FfiConverterRustBuffer<List<Suggestion>>

FfiConverterSequenceTypeSuggestionProvider

object FfiConverterSequenceTypeSuggestionProvider : FfiConverterRustBuffer<List<SuggestionProvider>>

FfiConverterString

object FfiConverterString : FfiConverter<String, RustBuffer.ByValue>

FfiConverterTypeInterruptKind

object FfiConverterTypeInterruptKind : FfiConverterRustBuffer<InterruptKind>

FfiConverterTypeLabeledTimingSample

object FfiConverterTypeLabeledTimingSample : FfiConverterRustBuffer<LabeledTimingSample>

FfiConverterTypeQueryWithMetricsResult

object FfiConverterTypeQueryWithMetricsResult : FfiConverterRustBuffer<QueryWithMetricsResult>

FfiConverterTypeSuggestApiError

object FfiConverterTypeSuggestApiError : FfiConverterRustBuffer<SuggestApiException>

FfiConverterTypeSuggestGlobalConfig

object FfiConverterTypeSuggestGlobalConfig : FfiConverterRustBuffer<SuggestGlobalConfig>

FfiConverterTypeSuggestIngestionConstraints

object FfiConverterTypeSuggestIngestionConstraints : FfiConverterRustBuffer<SuggestIngestionConstraints>

FfiConverterTypeSuggestIngestionMetrics

object FfiConverterTypeSuggestIngestionMetrics : FfiConverterRustBuffer<SuggestIngestionMetrics>

FfiConverterTypeSuggestion

object FfiConverterTypeSuggestion : FfiConverterRustBuffer<Suggestion>

FfiConverterTypeSuggestionProvider

object FfiConverterTypeSuggestionProvider : FfiConverterRustBuffer<SuggestionProvider>

FfiConverterTypeSuggestionProviderConstraints

object FfiConverterTypeSuggestionProviderConstraints : FfiConverterRustBuffer<SuggestionProviderConstraints>

FfiConverterTypeSuggestionQuery

object FfiConverterTypeSuggestionQuery : FfiConverterRustBuffer<SuggestionQuery>

FfiConverterTypeSuggestProviderConfig

object FfiConverterTypeSuggestProviderConfig : FfiConverterRustBuffer<SuggestProviderConfig>

FfiConverterTypeSuggestStore

object FfiConverterTypeSuggestStore : FfiConverter<SuggestStore, <Error class: unknown class>>

FfiConverterTypeSuggestStoreBuilder

object FfiConverterTypeSuggestStoreBuilder : FfiConverter<SuggestStoreBuilder, <Error class: unknown class>>

FfiConverterULong

object FfiConverterULong : FfiConverter<ULong, Long>

open class ForeignBytes

InternalException

class InternalException(message: String) : Exception

enum InterruptKind : Enum<InterruptKind>

What should be interrupted when SuggestStore::interrupt is called?

LabeledTimingSample

data class LabeledTimingSample(var label: String, var value: ULong)

Single sample for a Glean labeled_timing_distribution

object NoPointer

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

QueryWithMetricsResult

data class QueryWithMetricsResult(var suggestions: List<Suggestion>, var queryTimes: List<LabeledTimingSample>)

open class RustBuffer

RustBufferByReference

class RustBufferByReference

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

SuggestApiException

sealed class SuggestApiException : Exception

The error type for all Suggest component operations. These errors are exposed to your application, which should handle them as needed.

SuggestGlobalConfig

data class SuggestGlobalConfig(var showLessFrequentlyCap: Int)

Global Suggest configuration data.

SuggestIngestionConstraints

data class SuggestIngestionConstraints(var providers: List<SuggestionProvider>? = null, var providerConstraints: SuggestionProviderConstraints? = null, var emptyOnly: Boolean = false)

Constraints limit which suggestions to ingest from Remote Settings.

SuggestIngestionMetrics

data class SuggestIngestionMetrics(var ingestionTimes: List<LabeledTimingSample>, var downloadTimes: List<LabeledTimingSample>)

Ingestion metrics

sealed class Suggestion

A suggestion from the database to show in the address bar.

SuggestionProvider

enum SuggestionProvider : Enum<SuggestionProvider>

A provider is a source of search suggestions.

SuggestionProviderConstraints

data class SuggestionProviderConstraints(var exposureSuggestionTypes: List<String>? = null)

Some providers manage multiple suggestion subtypes. Queries, ingests, and other operations on those providers must be constrained to a desired subtype.

SuggestionQuery

data class SuggestionQuery(var keyword: String, var providers: List<SuggestionProvider>, var providerConstraints: SuggestionProviderConstraints? = null, var limit: Int? = null)

A query for suggestions to show in the address bar.

SuggestProviderConfig

sealed class SuggestProviderConfig

Per-provider configuration data.

open class SuggestStore : Disposable, AutoCloseable, SuggestStoreInterface

The store is the entry point to the Suggest component. It incrementally downloads suggestions from the Remote Settings service, stores them in a local database, and returns them in response to user queries.

SuggestStoreBuilder

open class SuggestStoreBuilder : Disposable, AutoCloseable, SuggestStoreBuilderInterface

Builder for SuggestStore

SuggestStoreBuilderInterface

interface SuggestStoreBuilderInterface

Builder for SuggestStore

SuggestStoreInterface

interface SuggestStoreInterface

The store is the entry point to the Suggest component. It incrementally downloads suggestions from the Remote Settings service, stores them in a local database, and returns them in response to user queries.

interface UniffiCleaner

UniffiNullRustCallStatusErrorHandler

object UniffiNullRustCallStatusErrorHandler : UniffiRustCallStatusErrorHandler<InternalException>

UniffiRustCallStatusErrorHandler

interface UniffiRustCallStatusErrorHandler<E>

Functions

rawSuggestionUrlMatches

fun rawSuggestionUrlMatches(rawUrl: String, cookedUrl: String): Boolean

Determines whether a "raw" sponsored suggestion URL is equivalent to a "cooked" URL. The two URLs are equivalent if they are identical except for their replaced template parameters, which can be different.

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