Skip to content

Commit fc58434

Browse files
committed
add some more docs to varbin vector
Signed-off-by: Connor Tsui <[email protected]>
1 parent a0808e7 commit fc58434

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

vortex-vector/src/varbin/mod.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
// SPDX-License-Identifier: Apache-2.0
22
// SPDX-FileCopyrightText: Copyright the Vortex contributors
33

4+
//! Definition and implementation of variable-length binary types.
5+
//!
6+
//! All types are wrappers around the [`VarBinVector`] type, which is represented internally by
7+
//! `BinaryView`s. `BinaryView`s are identical to the `BinaryView` type defined by the Arrow
8+
//! [specification](https://arrow.apache.org/docs/format/Columnar.html#variable-size-binary-view-layout),
9+
//! which are inspired by "German" strings.
10+
411
pub use types::*;
512
pub use vector::*;
613
pub use vector_mut::*;

vortex-vector/src/varbin/types.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ pub trait VarBinTypeUpcast {
8585

8686
/// Private module to seal the [`VarBinType`] trait.
8787
mod private {
88-
/// Sealed trait to prevent external implementations of [`VarBinType`].
88+
/// Sealed trait to prevent external implementations of [`VarBinType`](super::VarBinType).
8989
pub trait Sealed {}
9090

9191
impl Sealed for super::StringType {}

0 commit comments

Comments
 (0)