API

`#github.com/xulang-org/packages/meilisearch`

import: meilisearch #github.com/xulang-org/packages/meilisearch

counts: 4 fns, 18 methods, 4 types, 0 consts, 0 ifaces

External package `meilisearch #github.com/xulang-org/packages/meilisearch`, provided by github.com/xulang-org/packages.

github.com/xulang-org/packages · 0.1.1 · Install and use

`client`

XuAPI

pub fn client(endpoint string, api_key string) MeiliClient

Purpose

client; returns MeiliClient.

Parameters

endpoint string: endpoint (string)
api_key string: api_key (string)

Returns

MeiliClient — a value of this type

`pool`

XuAPI

pub fn pool(endpoint string, api_key string, max_conns int) MeiliPool

Purpose

pool; returns MeiliPool.

Parameters

endpoint string: endpoint (string)
api_key string: api_key (string)
max_conns int: max_conns (int)

Returns

MeiliPool — a value of this type

`struct MeiliClient`

XuAPI

pub struct MeiliClient {
    pub host string
    pub port int
    pub api_key string
}

Purpose

Public struct `MeiliClient`.

Parameters

host string: host
port int: port
api_key string: field (string)

`new_client`

XuAPI

pub fn new_client(endpoint string, api_key string) MeiliClient

Purpose

Construct client.

Parameters

endpoint string: endpoint (string)
api_key string: api_key (string)

Returns

MeiliClient — a value of this type

`(MeiliClient) connect`

XuAPI

pub fn (c MeiliClient) connect() int

Purpose

Call `connect` on `MeiliClient`. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)

Returns

int — a value of this type

`(MeiliClient) do_request_on_fd`

XuAPI

pub fn (c MeiliClient) do_request_on_fd(fd int, method string, path string, body string) string

Purpose

Method on `MeiliClient`: do request on fd. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)
fd int: file descriptor (int)
method string: method (string)
path string: filesystem path (string)
body string: body (string)

Returns

string — result string

`(MeiliClient) do_request`

XuAPI

pub fn (c MeiliClient) do_request(method string, path string, body string) string

Purpose

Method on `MeiliClient`: do request. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)
method string: method (string)
path string: filesystem path (string)
body string: body (string)

Returns

string — result string

`(MeiliClient) health`

XuAPI

pub fn (c MeiliClient) health() bool

Purpose

Call `health` on `MeiliClient`.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)

Returns

bool — true or false

`(MeiliClient) create_index`

XuAPI

pub fn (c MeiliClient) create_index(uid string, primary_key string) bool

Purpose

Method on `MeiliClient`: create index. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)
uid string: uid (string)
primary_key string: primary_key (string)

Returns

bool — true or false

`(MeiliClient) delete_index`

XuAPI

pub fn (c MeiliClient) delete_index(uid string) bool

Purpose

Method on `MeiliClient`: delete index. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)
uid string: uid (string)

Returns

bool — true or false

`(MeiliClient) add_documents`

XuAPI

pub fn (c MeiliClient) add_documents(uid string, json_docs string) bool

Purpose

Method on `MeiliClient`: add documents. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)
uid string: uid (string)
json_docs string: json_docs (string)

Returns

bool — true or false

`(MeiliClient) search`

XuAPI

pub fn (c MeiliClient) search(uid string, query string, limit int) SearchResult

Purpose

Method on `MeiliClient`: binary search. Throws on failure.

Parameters

c MeiliClient: receiver MeiliClient (value receiver)
uid string: uid (string)
query string: query (string)
limit int: limit (int)

Returns

SearchResult — a value of this type

`struct MeiliPool`

XuAPI

pub struct MeiliPool {
    pub client MeiliClient
    pub state chan pool.State
    pub max_idle int
}

Purpose

Public struct `MeiliPool`.

Parameters

client MeiliClient: field (MeiliClient)
state chan pool.State: field (channel; type chan pool.State)
max_idle int: field (int)

`open_pool`

XuAPI

pub fn open_pool(endpoint string, api_key string, max_idle int) MeiliPool

Purpose

Open pool.

Parameters

endpoint string: endpoint (string)
api_key string: api_key (string)
max_idle int: max_idle (int)

Returns

MeiliPool — a value of this type

`(&MeiliPool) dup`

XuAPI

pub fn (p &MeiliPool) dup() MeiliPool

Purpose

Copies configuration while sharing the connection and close lifecycle.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)

Returns

MeiliPool — a value of this type

`(&MeiliPool) get_conn`

XuAPI

pub fn (p &MeiliPool) get_conn() int

Purpose

Method on `&MeiliPool`: read conn.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)

Returns

int — a value of this type

`(&MeiliPool) put_conn`

XuAPI

pub fn (p &MeiliPool) put_conn(fd int)

Purpose

Method on `&MeiliPool`: put connection.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)
fd int: file descriptor (int)

`(&MeiliPool) discard_conn`

XuAPI

pub fn (p &MeiliPool) discard_conn(fd int)

Purpose

Method on `&MeiliPool`: discard connection.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)
fd int: file descriptor (int)

`(&MeiliPool) health`

XuAPI

pub fn (p &MeiliPool) health() bool

Purpose

Call `health` on `&MeiliPool`.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)

Returns

bool — true or false

`(&MeiliPool) create_index`

XuAPI

pub fn (p &MeiliPool) create_index(uid string, primary_key string) bool

Purpose

Method on `&MeiliPool`: create index. Throws on failure.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)
uid string: uid (string)
primary_key string: primary_key (string)

Returns

bool — true or false

`(&MeiliPool) delete_index`

XuAPI

pub fn (p &MeiliPool) delete_index(uid string) bool

Purpose

Method on `&MeiliPool`: delete index. Throws on failure.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)
uid string: uid (string)

Returns

bool — true or false

`(&MeiliPool) add_documents`

XuAPI

pub fn (p &MeiliPool) add_documents(uid string, json_docs string) bool

Purpose

Method on `&MeiliPool`: add documents. Throws on failure.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)
uid string: uid (string)
json_docs string: json_docs (string)

Returns

bool — true or false

`(&MeiliPool) search`

XuAPI

pub fn (p &MeiliPool) search(uid string, query string, limit int) SearchResult

Purpose

Method on `&MeiliPool`: binary search. Throws on failure.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)
uid string: uid (string)
query string: query (string)
limit int: limit (int)

Returns

SearchResult — a value of this type

`(&MeiliPool) close`

XuAPI

pub fn (p &MeiliPool) close()

Purpose

Method on `&MeiliPool`: close the resource.

Parameters

p &MeiliPool: receiver &MeiliPool (borrow)

`struct SearchHit`

XuAPI

pub struct SearchHit {
    pub id int
    pub title string
    pub raw string
}

Purpose

Public struct `SearchHit`.

Parameters

id int: field (int)
title string: field (string)
raw string: field (string)

`struct SearchResult`

XuAPI

pub struct SearchResult {
    pub query string
    pub total_hits int
    pub hits []SearchHit
}

Purpose

Public struct `SearchResult`.

Parameters

query string: field (string)
total_hits int: field (int)
hits []SearchHit: field ([]SearchHit)