Skip to content

Commit cdb9972

Browse files
RealKai42RealKai42
authored
Merge pull request RealKai42#902 from tendguo/colin-master
feat: add some rust api docs
2 parents 38df7f6 + 821b9c1 commit cdb9972

File tree

5 files changed

+712
-0
lines changed

5 files changed

+712
-0
lines changed

‎public/dicts/rust-hashmap.json

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
[
2+
{
3+
"name": "HashMap::new()",
4+
"trans": [
5+
"`HashMap::new()` 方法创建并返回一个新的空 `HashMap`，其键和值的类型由泛型指定。"
6+
]
7+
},
8+
{
9+
"name": "HashMap::with_capacity()",
10+
"trans": [
11+
"`HashMap::with_capacity()` 方法创建一个指定容量的空 `HashMap`，用于优化内存分配，减少需要扩展时的内存重分配次数。"
12+
]
13+
},
14+
{
15+
"name": "HashMap::insert()",
16+
"trans": [
17+
"`HashMap::insert()` 方法将指定的键值对插入到 `HashMap` 中。如果该键已存在，则会更新其对应的值。"
18+
]
19+
},
20+
{
21+
"name": "HashMap::get()",
22+
"trans": [
23+
"`HashMap::get()` 方法根据给定的键查询并返回其对应的值。如果键不存在，则返回 `None`。"
24+
]
25+
},
26+
{
27+
"name": "HashMap::remove()",
28+
"trans": [
29+
"`HashMap::remove()` 方法移除并返回指定键对应的值，如果该键不存在，返回 `None`。"
30+
]
31+
},
32+
{
33+
"name": "HashMap::contains_key()",
34+
"trans": [
35+
"`HashMap::contains_key()` 方法检查 `HashMap` 是否包含指定的键，返回布尔值。"
36+
]
37+
},
38+
{
39+
"name": "HashMap::len()",
40+
"trans": [
41+
"`HashMap::len()` 方法返回 `HashMap` 中键值对的个数。"
42+
]
43+
},
44+
{
45+
"name": "HashMap::is_empty()",
46+
"trans": [
47+
"`HashMap::is_empty()` 方法返回布尔值，表示 `HashMap` 是否为空。"
48+
]
49+
},
50+
{
51+
"name": "HashMap::clear()",
52+
"trans": [
53+
"`HashMap::clear()` 方法移除 `HashMap` 中的所有键值对，但不释放内存。"
54+
]
55+
},
56+
{
57+
"name": "HashMap::iter()",
58+
"trans": [
59+
"`HashMap::iter()` 方法返回一个迭代器，可以遍历 `HashMap` 中的所有键值对。"
60+
]
61+
},
62+
{
63+
"name": "HashMap::keys()",
64+
"trans": [
65+
"`HashMap::keys()` 方法返回一个包含所有键的迭代器，允许遍历所有键。"
66+
]
67+
},
68+
{
69+
"name": "HashMap::values()",
70+
"trans": [
71+
"`HashMap::values()` 方法返回一个包含所有值的迭代器，允许遍历所有值。"
72+
]
73+
},
74+
{
75+
"name": "HashMap::into_iter()",
76+
"trans": [
77+
"`HashMap::into_iter()` 方法消耗 `HashMap`，并返回一个迭代器，能够遍历并移除其中的键值对。"
78+
]
79+
},
80+
{
81+
"name": "HashMap::entry()",
82+
"trans": [
83+
"`HashMap::entry()` 方法返回一个 `Entry` 类型，允许对指定的键执行插入或修改操作。如果键不存在，可以插入新值。"
84+
]
85+
},
86+
{
87+
"name": "HashMap::clone()",
88+
"trans": [
89+
"`HashMap::clone()` 方法创建并返回 `HashMap` 的一个深拷贝。"
90+
]
91+
},
92+
{
93+
"name": "HashMap::extend()",
94+
"trans": [
95+
"`HashMap::extend()` 方法将另一个 `HashMap` 或可迭代的键值对添加到当前的 `HashMap` 中。"
96+
]
97+
},
98+
{
99+
"name": "HashMap::retain()",
100+
"trans": [
101+
"`HashMap::retain()` 方法保留满足给定条件的键值对，移除不符合条件的键值对。"
102+
]
103+
},
104+
{
105+
"name": "HashMap::remove_entry()",
106+
"trans": [
107+
"`HashMap::remove_entry()` 方法移除指定键对应的键值对，并返回该键值对。"
108+
]
109+
},
110+
{
111+
"name": "HashMap::get_mut()",
112+
"trans": [
113+
"`HashMap::get_mut()` 方法获取指定键对应值的可变引用，如果该键不存在，则返回 `None`。"
114+
]
115+
},
116+
{
117+
"name": "HashMap::values_mut()",
118+
"trans": [
119+
"`HashMap::values_mut()` 方法返回一个可变迭代器，允许修改 `HashMap` 中的所有值。"
120+
]
121+
},
122+
{
123+
"name": "HashMap::swap_remove()",
124+
"trans": [
125+
"`HashMap::swap_remove()` 方法移除指定键对应的键值对，并将该键值对与 `HashMap` 中最后一个键值对交换，避免内存的重新分配。"
126+
]
127+
},
128+
{
129+
"name": "HashMap::shrink_to_fit()",
130+
"trans": [
131+
"`HashMap::shrink_to_fit()` 方法会尝试将 `HashMap` 的容量调整为当前元素的实际数量，从而节省内存。"
132+
]
133+
},
134+
{
135+
"name": "HashMap::capacity()",
136+
"trans": [
137+
"`HashMap::capacity()` 方法返回 `HashMap` 当前的容量，即它可以容纳的键值对的最大数量。"
138+
]
139+
}
140+
]

‎public/dicts/rust-keyword.json

+212
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
[
2+
{
3+
"name": "as",
4+
"trans": [
5+
"`as` 用于进行类型转换（类型别名），将一种类型转换为另一种类型，通常用于强制类型转换或者是简化泛型。"
6+
]
7+
},
8+
{
9+
"name": "async",
10+
"trans": [
11+
"`async` 用于定义异步函数或闭包，表示该函数将返回一个 `Future`，可以通过 `await` 来等待其执行结果。"
12+
]
13+
},
14+
{
15+
"name": "await",
16+
"trans": [
17+
"`await` 用于在异步上下文中等待异步操作的完成。它只能在 `async` 函数中使用。"
18+
]
19+
},
20+
{
21+
"name": "break",
22+
"trans": [
23+
"`break` 用于跳出当前的循环或 `match` 语句，终止循环或匹配。"
24+
]
25+
},
26+
{
27+
"name": "const",
28+
"trans": [
29+
"`const` 用于定义常量，其值在编译时就已经确定，并且值不可变。常量的类型必须显式指定。"
30+
]
31+
},
32+
{
33+
"name": "continue",
34+
"trans": [
35+
"`continue` 用于跳过当前循环的剩余部分，继续执行下一次循环。"
36+
]
37+
},
38+
{
39+
"name": "crate",
40+
"trans": [
41+
"`crate` 表示当前包（crate），用于标识模块或外部 crate 的路径。"
42+
]
43+
},
44+
{
45+
"name": "dyn",
46+
"trans": [
47+
"`dyn` 用于创建 trait 对象，允许在运行时动态调用 trait 中定义的方法。"
48+
]
49+
},
50+
{
51+
"name": "else",
52+
"trans": [
53+
"`else` 用于与 `if` 语句配合，指定条件不成立时执行的代码块。"
54+
]
55+
},
56+
{
57+
"name": "enum",
58+
"trans": [
59+
"`enum` 用于定义枚举类型，枚举可以有多个变体，每个变体可以包含不同类型的数据。"
60+
]
61+
},
62+
{
63+
"name": "extern",
64+
"trans": [
65+
"`extern` 用于声明外部函数或外部库（通常是 C 或其他语言），以便可以在 Rust 代码中调用。"
66+
]
67+
},
68+
{
69+
"name": "fn",
70+
"trans": [
71+
"`fn` 用于定义函数。函数有一个明确的返回类型（如果有的话），并且可以接受参数。"
72+
]
73+
},
74+
{
75+
"name": "for",
76+
"trans": [
77+
"`for` 用于创建一个迭代循环，通常用来遍历集合、范围或其他可迭代的类型。"
78+
]
79+
},
80+
{
81+
"name": "if",
82+
"trans": [
83+
"`if` 用于执行条件判断语句，如果条件为真，则执行对应代码块。"
84+
]
85+
},
86+
{
87+
"name": "impl",
88+
"trans": [
89+
"`impl` 用于为类型（如结构体、枚举或 trait）实现方法，或者为类型实现某个 trait。"
90+
]
91+
},
92+
{
93+
"name": "in",
94+
"trans": [
95+
"`in` 用于模式匹配中，表示模式的匹配条件。通常与 `for` 循环一起使用。"
96+
]
97+
},
98+
{
99+
"name": "let",
100+
"trans": [
101+
"`let` 用于声明变量或常量，常用来进行值绑定，支持可变和不可变绑定。"
102+
]
103+
},
104+
{
105+
"name": "loop",
106+
"trans": [
107+
"`loop` 用于创建一个无限循环，直到使用 `break` 或其他控制流语句终止。"
108+
]
109+
},
110+
{
111+
"name": "match",
112+
"trans": [
113+
"`match` 用于模式匹配，根据给定的值匹配多个可能的情况并执行相应的代码块。"
114+
]
115+
},
116+
{
117+
"name": "mod",
118+
"trans": [
119+
"`mod` 用于定义模块，模块是组织代码的基本单元，包含函数、结构体、枚举等内容。"
120+
]
121+
},
122+
{
123+
"name": "move",
124+
"trans": [
125+
"`move` 用于捕获闭包中的值时，强制将其所有权转移给闭包，而非通过引用传递。"
126+
]
127+
},
128+
{
129+
"name": "mut",
130+
"trans": [
131+
"`mut` 用于声明一个可变变量或可变引用，表示该变量的值可以被修改。"
132+
]
133+
},
134+
{
135+
"name": "pub",
136+
"trans": [
137+
"`pub` 用于将项（如结构体、函数或模块）标记为公有，使得它们可以在模块外部访问。"
138+
]
139+
},
140+
{
141+
"name": "ref",
142+
"trans": [
143+
"`ref` 用于通过引用模式匹配值，避免值的所有权转移，而是获取一个引用。"
144+
]
145+
},
146+
{
147+
"name": "return",
148+
"trans": [
149+
"`return` 用于从函数中返回值，终止函数执行并返回控制权给调用者。"
150+
]
151+
},
152+
{
153+
"name": "self",
154+
"trans": [
155+
"`self` 表示当前实例，在方法定义中引用调用该方法的对象。"
156+
]
157+
},
158+
{
159+
"name": "static",
160+
"trans": [
161+
"`static` 用于声明具有静态生命周期的变量，这些变量在程序的整个生命周期中都存在。"
162+
]
163+
},
164+
{
165+
"name": "struct",
166+
"trans": [
167+
"`struct` 用于定义结构体类型，它是一种自定义的数据类型，可以包含多个字段。"
168+
]
169+
},
170+
{
171+
"name": "super",
172+
"trans": [
173+
"`super` 用于引用父模块，通常用于访问父模块中的函数或类型。"
174+
]
175+
},
176+
{
177+
"name": "trait",
178+
"trans": [
179+
"`trait` 用于定义 trait，它是一组方法签名，可以被不同的类型实现以提供共享功能。"
180+
]
181+
},
182+
{
183+
"name": "type",
184+
"trans": [
185+
"`type` 用于定义类型别名，或者在泛型中为类型参数指定约束条件。"
186+
]
187+
},
188+
{
189+
"name": "unsafe",
190+
"trans": [
191+
"`unsafe` 用于标记不安全的代码块，允许进行一些编译器不检查的操作，如直接操作指针等。"
192+
]
193+
},
194+
{
195+
"name": "use",
196+
"trans": [
197+
"`use` 用于将模块、函数、类型等引入当前作用域，减少代码冗余并简化访问路径。"
198+
]
199+
},
200+
{
201+
"name": "where",
202+
"trans": [
203+
"`where` 用于在泛型约束中指定类型约束，通常用于定义函数或结构体时的类型参数约束。"
204+
]
205+
},
206+
{
207+
"name": "while",
208+
"trans": [
209+
"`while` 用于创建一个基于条件判断的循环，只要条件为真，循环就会继续执行。"
210+
]
211+
}
212+
]

0 commit comments

Comments
 (0)