Skip to content

Commit

Permalink
add documentation to the Encoding enum
Browse files Browse the repository at this point in the history
  • Loading branch information
broccoliSpicy committed Oct 9, 2024
1 parent 2683106 commit 71667ff
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions rust/lance-encoding/src/data.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ use lance_core::{Error, Result};

use crate::{buffer::LanceBuffer, statistics::Stat};

/// `Encoding` enum serves as a encoding registeration center.
/// All the encodings added to Lance should register here, and
/// these encodings can be dynamically selected during encoding,
/// users can also specify the particular encoding they want to use in the field metadata.
#[derive(Debug)]
pub enum Encoding {
Bitpack,
Expand Down

0 comments on commit 71667ff

Please sign in to comment.