narrow 0.15.1

An implementation of Apache Arrow
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

#![cfg_attr(not(feature = "derive"), doc = "# Narrow")]
#![cfg_attr(feature = "derive", doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md")))]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/mbrobbel/narrow/main/narrow.svg",
    html_favicon_url = "https://raw.githubusercontent.com/mbrobbel/narrow/main/narrow.svg"
)]
#![cfg_attr(docsrs, feature(doc_cfg))]
// The goal of the list of lints here is to help reduce complexity and improve consistency
#![deny(
    // Rustc
    missing_copy_implementations,
    // missing_debug_implementations,
    missing_docs,
    noop_method_call,
    // warnings,
    unused,
    // Clippy
    clippy::all,
    clippy::suspicious,
    clippy::style,
    clippy::complexity,
    clippy::perf,
    clippy::pedantic,
    // clippy::restrictions
    // clippy::arithmetic_side_effects, TODO(mbrobbel): check all
    clippy::as_conversions,
    clippy::as_underscore,
    clippy::clone_on_ref_ptr,
    clippy::decimal_literal_representation,
    clippy::empty_structs_with_brackets,
    clippy::get_unwrap,
    clippy::if_then_some_else_none,
    clippy::missing_docs_in_private_items,
    clippy::multiple_unsafe_ops_per_block,
    clippy::pattern_type_mismatch,
    clippy::rest_pat_in_fully_bound_structs,
    clippy::same_name_method,
    clippy::self_named_module_files,
    clippy::semicolon_outside_block,
    clippy::shadow_reuse,
    clippy::shadow_same,
    clippy::shadow_unrelated,
    clippy::str_to_string,
    clippy::string_add,
    clippy::tests_outside_test_module,
    clippy::undocumented_unsafe_blocks,
    clippy::unnecessary_safety_comment,
    clippy::unnecessary_safety_doc,
    clippy::unnecessary_self_imports,
    clippy::unneeded_field_pattern,
    clippy::unseparated_literal_suffix,
    clippy::unwrap_used,
    // Rustdoc
    // rustdoc::all
)]
#![allow(
    clippy::module_name_repetitions,
    clippy::pub_use,
    unsafe_op_in_unsafe_fn
)]

mod fixed_size;
pub use self::fixed_size::FixedSize;

mod length;
pub use self::length::Length;

mod index;
pub use self::index::Index;

pub mod buffer;

pub mod bitmap;

mod nullability;
pub use nullability::{NonNullable, Nullability, Nullable};

// TODO(mbrobbel): pub(crate)
pub mod offset;
pub(crate) mod validity;

pub mod array;

pub mod logical;

#[cfg(feature = "arrow-rs")]
pub mod arrow;

// Re-export arrow crates.
#[cfg(feature = "arrow-rs")]
pub use arrow_array;
#[cfg(feature = "arrow-rs")]
pub use arrow_buffer;
#[cfg(feature = "arrow-rs")]
pub use arrow_schema;

// Re-export `narrow_derive` macros when the `derive` feature is enabled.
#[cfg(feature = "derive")]
pub use narrow_derive::ArrayType;

// This allows using the `ArrayType` derive macro in tests.
#[cfg(any(all(test, feature = "derive"), feature = "map"))]
extern crate self as narrow;