XU XUv0.8.8
EN

API

#encoding/xun

import: #encoding/xun

counts: 3 函数, 36 方法, 1 类型, 5 常量, 0 方法集

XUN 文档。parse 得池化 Doc。

const kind_dict

XuAPI
pub const kind_dict = 0

用途

公开常量 `kind_dict`。 值为 `0`

参数

无

const kind_list

XuAPI
pub const kind_list = 1

用途

公开常量 `kind_list`。 值为 `1`

参数

无

const kind_scalar

XuAPI
pub const kind_scalar = 2

用途

公开常量 `kind_scalar`。 值为 `2`

参数

无

const max_bytes

XuAPI
pub const max_bytes = 1048576

用途

公开常量 `max_bytes`。 值为 `1048576`

参数

无

const max_depth

XuAPI
pub const max_depth = 64

用途

公开常量 `max_depth`。 值为 `64`

参数

无

struct Doc

XuAPI
pub struct Doc {
    pub kinds []int
    pub tags []string
    pub texts []string
    pub keys []string
    pub firsts []int
    pub nexts []int
    pub lasts []int
    pub root_idx int
    pub err string
    pub line int
    pub lines []string
    pub nos []int
    pub i int
    pub tok_kind int
    pub tok_no int
    pub tok_key string
    pub tok_inline string
}

用途

公开结构体 `Doc`。

参数

kinds []int
字段（[]int）
tags []string
字段（[]string）
texts []string
字段（[]string）
keys []string
字段（[]string）
firsts []int
字段（[]int）
nexts []int
字段（[]int）
lasts []int
字段（[]int）
root_idx int
字段（int）
err string
错误
line int
字段（int）
lines []string
字段（[]string）
nos []int
字段（[]int）
i int
下标或整数
tok_kind int
字段（int）
tok_no int
字段（int）
tok_key string
字段（string）
tok_inline string
字段（string）

new_doc

XuAPI
pub fn new_doc() Doc

用途

构造 doc。

参数

无

返回

Doc — 该类型的值

(Doc) ok

XuAPI
pub fn (d Doc) ok() bool

用途

在 `Doc` 上调用 `ok`。

参数

d Doc
接收者 Doc（值接收者）

返回

bool — 是否成立

(Doc) error

XuAPI
pub fn (d Doc) error() string

用途

`Doc` 上的方法：错误。

参数

d Doc
接收者 Doc（值接收者）

返回

string — 结果字符串

(Doc) error_line

XuAPI
pub fn (d Doc) error_line() int

用途

`Doc` 上的方法：错误line。

参数

d Doc
接收者 Doc（值接收者）

返回

int — 该类型的值

(Doc) root

XuAPI
pub fn (d Doc) root() int

用途

在 `Doc` 上调用 `root`。

参数

d Doc
接收者 Doc（值接收者）

返回

int — 该类型的值

(Doc) kind

XuAPI
pub fn (d Doc) kind(n int) int

用途

在 `Doc` 上调用 `kind`。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

int — 该类型的值

(Doc) is_dict

XuAPI
pub fn (d Doc) is_dict(n int) bool

用途

`Doc` 上的方法：判断是否 dict。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

bool — 是否成立

(Doc) is_list

XuAPI
pub fn (d Doc) is_list(n int) bool

用途

`Doc` 上的方法：判断是否 list。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

bool — 是否成立

(Doc) is_scalar

XuAPI
pub fn (d Doc) is_scalar(n int) bool

用途

`Doc` 上的方法：判断是否 scalar。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

bool — 是否成立

(Doc) tag

XuAPI
pub fn (d Doc) tag(n int) string

用途

`Doc` 上的方法：标签。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

string — 结果字符串

(Doc) text

XuAPI
pub fn (d Doc) text(n int) string

用途

`Doc` 上的方法：返回当前文本。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

string — 结果字符串

(Doc) key

XuAPI
pub fn (d Doc) key(n int) string

用途

`Doc` 上的方法：键。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

string — 结果字符串

(Doc) count

XuAPI
pub fn (d Doc) count(n int) int

用途

`Doc` 上的方法：统计非重叠出现次数。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

int — 该类型的值

(Doc) at

XuAPI
pub fn (d Doc) at(n int, i int) int

用途

在 `Doc` 上调用 `at`。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）
i int
下标或整数（int）

返回

int — 该类型的值

(Doc) get

XuAPI
pub fn (d Doc) get(n int, key string) int

用途

在 `Doc` 上调用 `get`。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）
key string
键（string）

返回

int — 该类型的值

(Doc) as_str

XuAPI
pub fn (d Doc) as_str(n int) string

用途

`Doc` 上的方法：asstr。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

string — 结果字符串

(Doc) as_int

XuAPI
pub fn (d Doc) as_int(n int) int

用途

`Doc` 上的方法：asint。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

int — 该类型的值

(Doc) as_f64

XuAPI
pub fn (d Doc) as_f64(n int) f64

用途

`Doc` 上的方法：asf64。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

f64 — 该类型的值

(Doc) as_bool

XuAPI
pub fn (d Doc) as_bool(n int) bool

用途

`Doc` 上的方法：asbool。

参数

d Doc
接收者 Doc（值接收者）
n int
数量、长度或上限（int）

返回

bool — 是否成立

(&mut Doc) set_root

XuAPI
pub fn (d &mut Doc) set_root(r int)

用途

`&mut Doc` 上的方法：设置 root。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
r int
rune（Unicode 码点）（int）

(&mut Doc) new_node

XuAPI
pub fn (d &mut Doc) new_node(kind int, tag string, text string, key string) int

用途

`&mut Doc` 上的方法：构造 node。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
kind int
类型标签（int）
tag string
tag（string）
text string
文本（string）
key string
键（string）

返回

int — 该类型的值

(&mut Doc) attach

XuAPI
pub fn (d &mut Doc) attach(parent int, child int)

用途

在 `&mut Doc` 上调用 `attach`。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
child int
child（int）

(&mut Doc) add_dict

XuAPI
pub fn (d &mut Doc) add_dict(parent int, key string) int

用途

`&mut Doc` 上的方法：增加dict。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）

返回

int — 该类型的值

(&mut Doc) add_list

XuAPI
pub fn (d &mut Doc) add_list(parent int, key string) int

用途

`&mut Doc` 上的方法：增加list。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）

返回

int — 该类型的值

(&mut Doc) add_scalar

XuAPI
pub fn (d &mut Doc) add_scalar(parent int, key string, tag string, text string) int

用途

`&mut Doc` 上的方法：增加scalar。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）
tag string
tag（string）
text string
文本（string）

返回

int — 该类型的值

(&mut Doc) add_str

XuAPI
pub fn (d &mut Doc) add_str(parent int, key string, val string) int

用途

`&mut Doc` 上的方法：增加str。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）
val string
值（string）

返回

int — 该类型的值

(&mut Doc) add_int

XuAPI
pub fn (d &mut Doc) add_int(parent int, key string, val int) int

用途

`&mut Doc` 上的方法：增加int。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）
val int
值（int）

返回

int — 该类型的值

(&mut Doc) add_f64

XuAPI
pub fn (d &mut Doc) add_f64(parent int, key string, val f64) int

用途

`&mut Doc` 上的方法：增加f64。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）
val f64
值（f64）

返回

int — 该类型的值

(&mut Doc) add_bool

XuAPI
pub fn (d &mut Doc) add_bool(parent int, key string, val bool) int

用途

`&mut Doc` 上的方法：增加bool。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
key string
键（string）
val bool
值（bool）

返回

int — 该类型的值

(&mut Doc) push_dict

XuAPI
pub fn (d &mut Doc) push_dict(parent int) int

用途

`&mut Doc` 上的方法：压入dict。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）

返回

int — 该类型的值

(&mut Doc) push_list

XuAPI
pub fn (d &mut Doc) push_list(parent int) int

用途

`&mut Doc` 上的方法：压入list。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）

返回

int — 该类型的值

(&mut Doc) push_scalar

XuAPI
pub fn (d &mut Doc) push_scalar(parent int, tag string, text string) int

用途

`&mut Doc` 上的方法：压入scalar。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
tag string
tag（string）
text string
文本（string）

返回

int — 该类型的值

(&mut Doc) push_str

XuAPI
pub fn (d &mut Doc) push_str(parent int, val string) int

用途

`&mut Doc` 上的方法：压入str。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
val string
值（string）

返回

int — 该类型的值

(&mut Doc) push_int

XuAPI
pub fn (d &mut Doc) push_int(parent int, val int) int

用途

`&mut Doc` 上的方法：压入int。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
val int
值（int）

返回

int — 该类型的值

(&mut Doc) push_f64

XuAPI
pub fn (d &mut Doc) push_f64(parent int, val f64) int

用途

`&mut Doc` 上的方法：压入f64。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
val f64
值（f64）

返回

int — 该类型的值

(&mut Doc) push_bool

XuAPI
pub fn (d &mut Doc) push_bool(parent int, val bool) int

用途

`&mut Doc` 上的方法：压入bool。

参数

d &mut Doc
接收者 &mut Doc（可变借用）
parent int
parent（int）
val bool
值（bool）

返回

int — 该类型的值

parse

XuAPI
pub fn parse(src &string) Doc

用途

解析输入。

参数

src &string
源数据（借用，调用方仍持有；类型 &string）

返回

Doc — 该类型的值

encode

XuAPI
pub fn encode(d &Doc) string

用途

编码。

参数

d &Doc
d（借用，调用方仍持有；类型 &Doc）

返回

string — 结果字符串

(Doc) to_xun

XuAPI
pub fn (d Doc) to_xun() string

用途

`Doc` 上的方法：转换为 xun。

参数

d Doc
接收者 Doc（值接收者）

返回

string — 结果字符串