XU XUv0.8.8
EN

API

#github.com/xulang-org/packages/mongodb

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

counts: 21 函数, 16 方法, 2 类型, 0 常量, 0 方法集

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

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

open

XuAPI
pub fn open(addr string) Client

用途

打开。失败时 throw。

参数

addr string
地址(string)

返回

Client — 该类型的值

open_pool

XuAPI
pub fn open_pool(addr string, max_idle int) Pool

用途

打开pool。

参数

addr string
地址(string)
max_idle int
max_idle(int)

返回

Pool — 该类型的值

encode_i32

XuAPI
pub fn encode_i32(v int) string

用途

编码。

参数

v int
值(int)

返回

string — 结果字符串

encode_i64

XuAPI
pub fn encode_i64(v int) string

用途

编码。

参数

v int
值(int)

返回

string — 结果字符串

decode_i32

XuAPI
pub fn decode_i32(s &string, off int) int

用途

解码。

参数

s &string
源字符串(借用,调用方仍持有;类型 &string)
off int
偏移(int)

返回

int — 该类型的值

build_doc

XuAPI
pub fn build_doc(elements string) string

用途

builddoc。

参数

elements string
elements(string)

返回

string — 结果字符串

bson_string

XuAPI
pub fn bson_string(name string, val string) string

用途

bson字符串。

参数

name string
名字(string)
val string
值(string)

返回

string — 结果字符串

bson_int32

XuAPI
pub fn bson_int32(name string, val int) string

用途

bsonint32。

参数

name string
名字(string)
val int
值(int)

返回

string — 结果字符串

bson_int64

XuAPI
pub fn bson_int64(name string, val int) string

用途

bsonint64。

参数

name string
名字(string)
val int
值(int)

返回

string — 结果字符串

bson_bool

XuAPI
pub fn bson_bool(name string, val bool) string

用途

bsonbool。

参数

name string
名字(string)
val bool
值(bool)

返回

string — 结果字符串

bson_doc

XuAPI
pub fn bson_doc(name string, doc_bytes string) string

用途

bsondoc。

参数

name string
名字(string)
doc_bytes string
doc_bytes(string)

返回

string — 结果字符串

bson_array

XuAPI
pub fn bson_array(name string, arr_bytes string) string

用途

bsonarray。

参数

name string
名字(string)
arr_bytes string
arr_bytes(string)

返回

string — 结果字符串

bson_object_id

XuAPI
pub fn bson_object_id(name string, oid_bytes string) string

用途

bsonobjectid。

参数

name string
名字(string)
oid_bytes string
oid_bytes(string)

返回

string — 结果字符串

bson_utc_datetime

XuAPI
pub fn bson_utc_datetime(name string, millis int) string

用途

bsonUTCdatetime。

参数

name string
名字(string)
millis int
millis(int)

返回

string — 结果字符串

bson_null

XuAPI
pub fn bson_null(name string) string

用途

bsonnull。

参数

name string
名字(string)

返回

string — 结果字符串

find_bson_string

XuAPI
pub fn find_bson_string(doc string, target_field string) string

用途

findbson字符串。

参数

doc string
doc(string)
target_field string
target_field(string)

返回

string — 结果字符串

is_bson_ok

XuAPI
pub fn is_bson_ok(doc string) bool

用途

判断是否 bson ok。

参数

doc string
doc(string)

返回

bool — 是否成立

struct Client

XuAPI
pub struct Client {
    pub fd int
    pub addr string
    pub next_req_id int
}

用途

公开结构体 `Client`。

参数

fd int
文件描述符
addr string
地址
next_req_id int
字段(int)

(&mut Client) write_exact

XuAPI
pub fn (c &mut Client) write_exact(data string) int

用途

`&mut Client` 上的方法:写入exact。失败时 throw。

参数

c &mut Client
接收者 &mut Client(可变借用)
data string
数据(string)

返回

int — 该类型的值

(&mut Client) read_exact

XuAPI
pub fn (c &mut Client) read_exact(n int) string

用途

`&mut Client` 上的方法:读取exact。失败时 throw。

参数

c &mut Client
接收者 &mut Client(可变借用)
n int
数量、长度或上限(int)

返回

string — 结果字符串

(&mut Client) run_command

XuAPI
pub fn (c &mut Client) run_command(db_name string, cmd_elements string) string

用途

`&mut Client` 上的方法:运行命令。失败时 throw。

参数

c &mut Client
接收者 &mut Client(可变借用)
db_name string
db_name(string)
cmd_elements string
cmd_elements(string)

返回

string — 结果字符串

connect

XuAPI
pub fn connect(addr string) Client

用途

connect,返回 Client。失败时 throw。

参数

addr string
地址(string)

返回

Client — 该类型的值

(&mut Client) hello

XuAPI
pub fn (c &mut Client) hello() bool

用途

在 `&mut Client` 上调用 `hello`。

参数

c &mut Client
接收者 &mut Client(可变借用)

返回

bool — 是否成立

(&mut Client) insert_one

XuAPI
pub fn (c &mut Client) insert_one(db_name string, col_name string, doc_bytes string) int

用途

`&mut Client` 上的方法:插入one。失败时 throw。

参数

c &mut Client
接收者 &mut Client(可变借用)
db_name string
db_name(string)
col_name string
col_name(string)
doc_bytes string
doc_bytes(string)

返回

int — 该类型的值

(&mut Client) find_first_string

XuAPI
pub fn (c &mut Client) find_first_string(db_name string, col_name string, target_field string) string

用途

`&mut Client` 上的方法:find首次字符串。失败时 throw。

参数

c &mut Client
接收者 &mut Client(可变借用)
db_name string
db_name(string)
col_name string
col_name(string)
target_field string
target_field(string)

返回

string — 结果字符串

(&mut Client) drop_collection

XuAPI
pub fn (c &mut Client) drop_collection(db_name string, col_name string) bool

用途

`&mut Client` 上的方法:dropcollection。

参数

c &mut Client
接收者 &mut Client(可变借用)
db_name string
db_name(string)
col_name string
col_name(string)

返回

bool — 是否成立

(&mut Client) close

XuAPI
pub fn (c &mut Client) close()

用途

`&mut Client` 上的方法:关闭资源。

参数

c &mut Client
接收者 &mut Client(可变借用)

struct Pool

XuAPI
pub struct Pool {
    pub addr string
    pub idle chan int
    pub max_idle int
}

用途

公开结构体 `Pool`。

参数

addr string
地址
idle chan int
字段(通道;类型 chan int)
max_idle int
字段(int)

new_pool

XuAPI
pub fn new_pool(addr string, max_idle int) Pool

用途

构造 pool。

参数

addr string
地址(string)
max_idle int
max_idle(int)

返回

Pool — 该类型的值

(&Pool) get

XuAPI
pub fn (p &Pool) get() Client

用途

在 `&Pool` 上调用 `get`。失败时 throw。

参数

p &Pool
接收者 &Pool(借用)

返回

Client — 该类型的值

(&Pool) put_conn

XuAPI
pub fn (p &Pool) put_conn(fd int)

用途

`&Pool` 上的方法:put连接。

参数

p &Pool
接收者 &Pool(借用)
fd int
文件描述符(int)

(&Pool) put

XuAPI
pub fn (p &Pool) put(c Client)

用途

在 `&Pool` 上调用 `put`。

参数

p &Pool
接收者 &Pool(借用)
c Client
字节或字符码(Client)

(&Pool) hello

XuAPI
pub fn (p &Pool) hello() bool

用途

在 `&Pool` 上调用 `hello`。

参数

p &Pool
接收者 &Pool(借用)

返回

bool — 是否成立

(&Pool) insert_one

XuAPI
pub fn (p &Pool) insert_one(db_name string, col_name string, doc_bytes string) int

用途

`&Pool` 上的方法:插入one。失败时 throw。

参数

p &Pool
接收者 &Pool(借用)
db_name string
db_name(string)
col_name string
col_name(string)
doc_bytes string
doc_bytes(string)

返回

int — 该类型的值

(&Pool) find_first_string

XuAPI
pub fn (p &Pool) find_first_string(db_name string, col_name string, target_field string) string

用途

`&Pool` 上的方法:find首次字符串。失败时 throw。

参数

p &Pool
接收者 &Pool(借用)
db_name string
db_name(string)
col_name string
col_name(string)
target_field string
target_field(string)

返回

string — 结果字符串

(&Pool) drop_collection

XuAPI
pub fn (p &Pool) drop_collection(db_name string, col_name string) bool

用途

`&Pool` 上的方法:dropcollection。

参数

p &Pool
接收者 &Pool(借用)
db_name string
db_name(string)
col_name string
col_name(string)

返回

bool — 是否成立

(&Pool) close

XuAPI
pub fn (p &Pool) close()

用途

`&Pool` 上的方法:关闭资源。

参数

p &Pool
接收者 &Pool(借用)

encode_op_msg

XuAPI
pub fn encode_op_msg(request_id int, doc_bytes string) string

用途

编码。

参数

request_id int
request_id(int)
doc_bytes string
doc_bytes(string)

返回

string — 结果字符串

decode_op_msg_doc

XuAPI
pub fn decode_op_msg_doc(raw string) string

用途

解码。失败时 throw。

参数

raw string
raw(string)

返回

string — 结果字符串