+19
-19
src/reference/functions.rs
+19
-19
src/reference/functions.rs
···
19
19
//! Check if values are equal.
20
20
//!
21
21
//! - Input parameters: two values
22
-
//! - Output: a boolean indicating whether the values are equal or not
22
+
//! - Output value: a boolean indicating whether the values are equal or not
23
23
//!
24
24
//! ## `is-null`
25
25
//!
26
26
//! Check if an optional value is missing.
27
27
//!
28
28
//! - Input parameters: one value
29
-
//! - Output: a boolean indicating whether the value is null or not
29
+
//! - Output value: a boolean indicating whether the value is null or not
30
30
//!
31
31
//! # Graph manipulation functions
32
32
//!
···
35
35
//! Creates a new graph node.
36
36
//!
37
37
//! - Input parameters: none
38
-
//! - Output: a reference to the new graph node
38
+
//! - Output value: a reference to the new graph node
39
39
//!
40
40
//! # Logical functions
41
41
//!
···
44
44
//! Negates a boolean value.
45
45
//!
46
46
//! - Input parameters: one boolean
47
-
//! - Output: the negation of the input value
47
+
//! - Output value: the negation of the input value
48
48
//!
49
49
//! ## `and`
50
50
//!
···
52
52
//! true if none of the inputs are false, otherwise false.
53
53
//!
54
54
//! - Input parameters: zero or more booleans
55
-
//! - Output: the conjunction of all the input booleans
55
+
//! - Output value: the conjunction of all the input booleans
56
56
//!
57
57
//! ## `or`
58
58
//!
···
60
60
//! true if any of the inputs are true, otherwise false.
61
61
//!
62
62
//! - Input parameters: zero or more booleans
63
-
//! - Output: the disjunction of all the input booleans
63
+
//! - Output value: the disjunction of all the input booleans
64
64
//!
65
65
//! # Mathematical functions
66
66
//!
···
69
69
//! Adds integers together.
70
70
//!
71
71
//! - Input parameters: zero or more integers
72
-
//! - Output: the sum of all of the input integers
72
+
//! - Output value: the sum of all of the input integers
73
73
//!
74
74
//! # String functions
75
75
//!
···
81
81
//! - `format`: a format string containing placeholders
82
82
//! - as many additional parameters as there are placeholders in the format string
83
83
//!
84
-
//! - Output: a formatted string with the placeholders replaced by formatted values
84
+
//! - Output value: a formatted string with the placeholders replaced by formatted values
85
85
//!
86
86
//! Placeholders are written as `{}`. To produce literal braces, use `{{` and `}}` instead.
87
87
//!
···
109
109
//! Concatenate list arguments.
110
110
//!
111
111
//! - Input parameters: list values
112
-
//! - Output: the concatenation of the input lists
112
+
//! - Output value: the concatenation of the input lists
113
113
//!
114
114
//! ## `is-empty`
115
115
//!
116
116
//! Test whether a list is empty or not.
117
117
//!
118
118
//! - Input parameters: a list value
119
-
//! - Output parameters: a boolean indicating whether the list is empty or not
119
+
//! - Output value: a boolean indicating whether the list is empty or not
120
120
//!
121
121
//! ## `length`
122
122
//!
123
123
//! Determine the length of a list.
124
124
//!
125
125
//! - Input parameters: a list value
126
-
//! - Output parameters: an integer indicating the length of the list
126
+
//! - Output value: an integer indicating the length of the list
127
127
//!
128
128
//! # Syntax manipulation functions
129
129
//!
···
133
133
//!
134
134
//! - Input parameters:
135
135
//! - `node`: A syntax node
136
-
//! - Output parameter:
136
+
//! - Output value:
137
137
//! - The index of `node` within its parent's list of _named_ children (i.e., the index that
138
138
//! would cause `ts_node_named_child` to return `node`)
139
139
//!
···
143
143
//!
144
144
//! - Input parameters:
145
145
//! - `node`: A syntax node
146
-
//! - Output parameter:
146
+
//! - Output value:
147
147
//! - The number of _named_ children in `node`
148
148
//!
149
149
//! ## `source-text`
···
152
152
//!
153
153
//! - Input parameters:
154
154
//! - `node`: A syntax node
155
-
//! - Output parameter:
155
+
//! - Output value:
156
156
//! - A string containing the source text represented by `node`
157
157
//!
158
158
//! ## `node-type`
···
162
162
//!
163
163
//! - Input parameters:
164
164
//! - `node`: A syntax node
165
-
//! - Output parameter:
165
+
//! - Output value:
166
166
//! - A string containing the type of `node`
167
167
//!
168
168
//! ## `start-column`
···
171
171
//!
172
172
//! - Input parameters:
173
173
//! - `node`: A syntax node
174
-
//! - Output parameter:
174
+
//! - Output value:
175
175
//! - The zero-based start column of `node`
176
176
//!
177
177
//! ## `start-row`
···
180
180
//!
181
181
//! - Input parameters:
182
182
//! - `node`: A syntax node
183
-
//! - Output parameter:
183
+
//! - Output value:
184
184
//! - The zero-based start row of `node`
185
185
//!
186
186
//! ## `end-column`
···
189
189
//!
190
190
//! - Input parameters:
191
191
//! - `node`: A syntax node
192
-
//! - Output parameter:
192
+
//! - Output value:
193
193
//! - The zero-based end column of `node`
194
194
//!
195
195
//! ## `end-row`
···
198
198
//!
199
199
//! - Input parameters:
200
200
//! - `node`: A syntax node
201
-
//! - Output parameter:
201
+
//! - Output value:
202
202
//! - The zero-based end row of `node`