API

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

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

counts: 4 函数, 18 方法, 4 类型, 0 常量, 0 方法集

扩展包 `meilisearch #github.com/xulang-org/packages/meilisearch`，由模块 github.com/xulang-org/packages 提供。

github.com/xulang-org/packages · 0.1.1 · 安装与使用

`client`

XuAPI

pub fn client(endpoint string, api_key string) MeiliClient

用途

客户端。

参数

endpoint string: endpoint（string）
api_key string: api_key（string）

MeiliClient — 该类型的值

`pool`

XuAPI

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

用途

pool，返回 MeiliPool。

参数

endpoint string: endpoint（string）
api_key string: api_key（string）
max_conns int: max_conns（int）

MeiliPool — 该类型的值

`struct MeiliClient`

XuAPI

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

用途

公开结构体 `MeiliClient`。

参数

host string: 主机
port int: 端口
api_key string: 字段（string）

`new_client`

XuAPI

pub fn new_client(endpoint string, api_key string) MeiliClient

用途

构造 client。

参数

endpoint string: endpoint（string）
api_key string: api_key（string）

MeiliClient — 该类型的值

`(MeiliClient) connect`

XuAPI

pub fn (c MeiliClient) connect() int

用途

在 `MeiliClient` 上调用 `connect`。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）

int — 该类型的值

`(MeiliClient) do_request_on_fd`

XuAPI

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

用途

`MeiliClient` 上的方法：执行一次请求于fd。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）
fd int: 文件描述符（int）
method string: method（string）
path string: 文件系统路径（string）
body string: 正文（string）

string — 结果字符串

`(MeiliClient) do_request`

XuAPI

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

用途

`MeiliClient` 上的方法：执行一次请求。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）
method string: method（string）
path string: 文件系统路径（string）
body string: 正文（string）

string — 结果字符串

`(MeiliClient) health`

XuAPI

pub fn (c MeiliClient) health() bool

用途

在 `MeiliClient` 上调用 `health`。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）

bool — 是否成立

`(MeiliClient) create_index`

XuAPI

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

用途

`MeiliClient` 上的方法：创建下标。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）
uid string: uid（string）
primary_key string: primary_key（string）

bool — 是否成立

`(MeiliClient) delete_index`

XuAPI

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

用途

`MeiliClient` 上的方法：删除下标。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）
uid string: uid（string）

bool — 是否成立

`(MeiliClient) add_documents`

XuAPI

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

用途

`MeiliClient` 上的方法：增加documents。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）
uid string: uid（string）
json_docs string: json_docs（string）

bool — 是否成立

`(MeiliClient) search`

XuAPI

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

用途

`MeiliClient` 上的方法：二分查找。失败时 throw。

参数

c MeiliClient: 接收者 MeiliClient（值接收者）
uid string: uid（string）
query string: query（string）
limit int: limit（int）

SearchResult — 该类型的值

`struct MeiliPool`

XuAPI

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

用途

公开结构体 `MeiliPool`。

参数

client MeiliClient: 字段（MeiliClient）
state chan pool.State: 字段（通道；类型 chan pool.State）
max_idle int: 字段（int）

`open_pool`

XuAPI

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

用途

打开pool。

参数

endpoint string: endpoint（string）
api_key string: api_key（string）
max_idle int: max_idle（int）

MeiliPool — 该类型的值

`(&MeiliPool) dup`

XuAPI

pub fn (p &MeiliPool) dup() MeiliPool

用途

在 `&MeiliPool` 上调用 `dup`。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）

MeiliPool — 该类型的值

`(&MeiliPool) get_conn`

XuAPI

pub fn (p &MeiliPool) get_conn() int

用途

`&MeiliPool` 上的方法：读取 conn。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）

int — 该类型的值

`(&MeiliPool) put_conn`

XuAPI

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

用途

`&MeiliPool` 上的方法：put连接。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）
fd int: 文件描述符（int）

`(&MeiliPool) discard_conn`

XuAPI

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

用途

`&MeiliPool` 上的方法：丢弃连接。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）
fd int: 文件描述符（int）

`(&MeiliPool) health`

XuAPI

pub fn (p &MeiliPool) health() bool

用途

在 `&MeiliPool` 上调用 `health`。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）

bool — 是否成立

`(&MeiliPool) create_index`

XuAPI

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

用途

`&MeiliPool` 上的方法：创建下标。失败时 throw。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）
uid string: uid（string）
primary_key string: primary_key（string）

bool — 是否成立

`(&MeiliPool) delete_index`

XuAPI

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

用途

`&MeiliPool` 上的方法：删除下标。失败时 throw。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）
uid string: uid（string）

bool — 是否成立

`(&MeiliPool) add_documents`

XuAPI

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

用途

`&MeiliPool` 上的方法：增加documents。失败时 throw。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）
uid string: uid（string）
json_docs string: json_docs（string）

bool — 是否成立

`(&MeiliPool) search`

XuAPI

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

用途

`&MeiliPool` 上的方法：二分查找。失败时 throw。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）
uid string: uid（string）
query string: query（string）
limit int: limit（int）

SearchResult — 该类型的值

`(&MeiliPool) close`

XuAPI

pub fn (p &MeiliPool) close()

用途

`&MeiliPool` 上的方法：关闭资源。

参数

p &MeiliPool: 接收者 &MeiliPool（借用）

`struct SearchHit`

XuAPI

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

用途

公开结构体 `SearchHit`。

参数

id int: 字段（int）
title string: 字段（string）
raw string: 字段（string）

`struct SearchResult`

XuAPI

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

用途

公开结构体 `SearchResult`。

参数

query string: 字段（string）
total_hits int: 字段（int）
hits []SearchHit: 字段（[]SearchHit）