luoyuxia commented on code in PR #433:
URL: https://github.com/apache/fluss-rust/pull/433#discussion_r2936565232
##########
website/docs/user-guide/rust/api-reference.md:
##########
@@ -402,6 +402,21 @@ Implements the `InternalRow` trait (see below).
| `fn get_bytes(&self, idx: usize) -> Result<&[u8]>`
| Get bytes value |
| `fn get_binary(&self, idx: usize, length: usize) -> Result<&[u8]>`
| Get fixed-length binary value |
| `fn get_char(&self, idx: usize, length: usize) -> Result<&str>`
| Get fixed-length char value |
+| `fn get_array(&self, idx: usize) -> Result<FlussArray>`
| Get array value |
+
+## `FlussArray`
+
+`FlussArray` is the Rust row representation for `ARRAY` values. You usually
obtain it from `InternalRow::get_array()`.
+
+| Method | Description |
+|--------|-------------|
+| `fn size(&self) -> usize` | Number of elements in the array |
+| `fn is_null_at(&self, pos: usize) -> bool` | Check whether an element is
null |
+| `fn as_bytes(&self) -> &[u8]` | Get encoded bytes of the array |
+
+Element getters mirror `InternalRow` typed getters and return `Result<T>`. For
example, use `get_int()`, `get_long()`, and `get_double()` for primitive
elements, and `get_string()`, `get_binary()`, `get_decimal()`,
`get_timestamp_ntz()`, `get_timestamp_ltz()`, and `get_array()` for
variable-length or nested elements.
+
+TODO: `FlussArray` currently exposes the fallible getter surface as the stable
API. Infallible fast-path variants may be added later as non-breaking
extensions if needed.
Review Comment:
why left todo in user-face document?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
