Structures Reference


                    
                    
                    MeiliSearch

A MeiliSearch instance represents a MeiliSearch client used to easily integrate your Swift product with the MeiliSearch server.

Warning

MeiliSearch instances are thread safe and can be shared across threads or dispatch queues.

Declaration

Swift

public struct MeiliSearch


                    
                    
                    Indexes

Undocumented

Declaration

Swift

public struct Indexes


                    
                    
                    Dump

Dump instances represent the current status of a dump in the server

Declaration

Swift

public struct Dump : Codable, Equatable


                    
                    
                    GetParameters

GetParameters instances represent query setup for a documents fetch request.

Declaration

Swift

public struct GetParameters : Codable, Equatable


                    
                    
                    Health

Health instances represent the status of the MeiliSearch server.

Declaration

Swift

public struct Health : Codable, Equatable


                    
                    
                    Index

Index instances is an entity that gathers a set of documents with its own settings. It can be comparable to a table in SQL, or a collection in MongoDB.

Declaration

Swift

public struct Index : Codable, Equatable

Key

Each instance of MeiliSearch has three keys: a master, a private, and a public. Each key has a given set of permissions on the API routes.

Declaration

Swift

public struct Key : Codable, Equatable


                    
                    
                    SearchParameters

SearchParameters instances represent query setup for a search request. Use SearchParameters.query to directly create a search query with the default search configuration.

Declaration

Swift

public struct SearchParameters : Codable, Equatable


                    
                    
                    SearchResult

SearchResult instances represent the result of a search. Requires that the value T conforms to the Codable and Equatable protocols.

Declaration

Swift

public struct SearchResult<T> : Codable, Equatable where T : Decodable, T : Encodable, T : Equatable


                    
                    
                    Setting

Settings object provided byb the user

Declaration

Swift

public struct Setting : Codable, Equatable


                    
                    
                    SettingResult

Returned Setting object with avoided nil values

Declaration

Swift

public struct SettingResult : Codable, Equatable


                    
                    
                    AllStats

AllStats instances represent stat of all Indexes.

Declaration

Swift

public struct AllStats : Codable, Equatable


                    
                    
                    Stat

AllStats instances represent stat of a specific Index.

Declaration

Swift

public struct Stat : Codable, Equatable


                    
                    
                    Update

Update instances represent the current transcation result, use the updateId value to verify the status of your transaction.

Declaration

Swift

public struct Update : Codable, Equatable


                    
                    
                    Version

Version instances represent the current version of the MeiliSearch server.

Declaration

Swift

public struct Version : Codable, Equatable


                    
                    
                    WaitOptions

WaitOptions struct represent the options used during a waitForPendingUpdate call.

Declaration

Swift

public struct WaitOptions : Codable, Equatable