Skip to content

Commit

Permalink
add vtab and chrono modules to docs (#295)
Browse files Browse the repository at this point in the history
* add features to document list

* apply clippy suggestions
  • Loading branch information
Mause authored Apr 17, 2024
1 parent 5407c0e commit d1ea4cb
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ path = "libduckdb-sys"
version = "0.10.1"

[package.metadata.docs.rs]
features = []
features = ['vtab', 'chrono']
all-features = false
no-default-features = true
default-target = "x86_64-unknown-linux-gnu"
Expand Down
2 changes: 1 addition & 1 deletion src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pub enum DefaultNullOrder {
}

/// duckdb configuration
/// Refer to https://github.com/duckdb/duckdb/blob/master/src/main/config.cpp
/// Refer to <https://github.com/duckdb/duckdb/blob/master/src/main/config.cpp>
#[derive(Default)]
pub struct Config {
config: Option<ffi::duckdb_config>,
Expand Down
1 change: 0 additions & 1 deletion src/vtab/arrow.rs
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,6 @@ pub fn to_duckdb_logical_type(data_type: &DataType) -> Result<LogicalType, Box<d
///
/// * `batch` - A reference to the `RecordBatch` to be converted to a `DataChunk`.
/// * `chunk` - A mutable reference to the `DataChunk` to store the converted data.
/// ```
pub fn record_batch_to_duckdb_data_chunk(
batch: &RecordBatch,
chunk: &mut DataChunk,
Expand Down
4 changes: 2 additions & 2 deletions src/vtab/logical_type.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::{
use crate::ffi::*;

/// Logical Type Id
/// https://duckdb.org/docs/api/c/types
/// <https://duckdb.org/docs/api/c/types>
#[repr(u32)]
#[derive(Debug, PartialEq, Eq)]
pub enum LogicalTypeId {
Expand Down Expand Up @@ -109,7 +109,7 @@ impl From<u32> for LogicalTypeId {
}

/// DuckDB Logical Type.
/// https://duckdb.org/docs/sql/data_types/overview
/// <https://duckdb.org/docs/sql/data_types/overview>
pub struct LogicalType {
pub(crate) ptr: duckdb_logical_type,
}
Expand Down
2 changes: 1 addition & 1 deletion src/vtab/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ pub trait Free {
/// Duckdb table function trait
///
/// See to the HelloVTab example for more details
/// https://duckdb.org/docs/api/c/table_functions
/// <https://duckdb.org/docs/api/c/table_functions>
pub trait VTab: Sized {
/// The data type of the bind data
type InitData: Sized + Free;
Expand Down

0 comments on commit d1ea4cb

Please sign in to comment.