vortex_flatbuffers/
lib.rs

1//! A contiguously serialized Vortex array.
2//!
3//! See [message] and [footer] for the flatbuffer specifications.
4//!
5//! See the `vortex-file` crate for non-contiguous serialization.
6
7#[cfg(feature = "array")]
8#[allow(clippy::all)]
9#[allow(clippy::derive_partial_eq_without_eq)]
10#[allow(clippy::many_single_char_names)]
11#[allow(clippy::unwrap_used)]
12#[allow(clippy::borrow_as_ptr)]
13#[allow(dead_code)]
14#[allow(non_snake_case)]
15#[allow(non_camel_case_types)]
16#[allow(unsafe_op_in_unsafe_fn)]
17#[allow(unused_imports)]
18#[allow(unused_lifetimes)]
19#[allow(unused_qualifications)]
20#[rustfmt::skip]
21#[path = "./generated/array.rs"]
22/// A serialized array without its buffer (i.e. data).
23///
24/// `array.fbs`:
25/// ```flatbuffers
26#[doc = include_str!("../flatbuffers/vortex-array/array.fbs")]
27/// ```
28pub mod array;
29
30#[cfg(feature = "dtype")]
31#[allow(clippy::all)]
32#[allow(clippy::derive_partial_eq_without_eq)]
33#[allow(clippy::many_single_char_names)]
34#[allow(clippy::unwrap_used)]
35#[allow(clippy::borrow_as_ptr)]
36#[allow(dead_code)]
37#[allow(non_snake_case)]
38#[allow(non_camel_case_types)]
39#[allow(unsafe_op_in_unsafe_fn)]
40#[allow(unused_imports)]
41#[allow(unused_lifetimes)]
42#[allow(unused_qualifications)]
43#[rustfmt::skip]
44#[path = "./generated/dtype.rs"]
45/// A serialized data type.
46///
47/// `dtype.fbs`:
48/// ```flatbuffers
49#[doc = include_str!("../flatbuffers/vortex-dtype/dtype.fbs")]
50/// ```
51pub mod dtype;
52
53#[cfg(feature = "file")]
54#[allow(clippy::all)]
55#[allow(clippy::derive_partial_eq_without_eq)]
56#[allow(clippy::many_single_char_names)]
57#[allow(clippy::unwrap_used)]
58#[allow(clippy::borrow_as_ptr)]
59#[allow(dead_code)]
60#[allow(non_snake_case)]
61#[allow(non_camel_case_types)]
62#[allow(unsafe_op_in_unsafe_fn)]
63#[allow(unused_imports)]
64#[allow(unused_lifetimes)]
65#[allow(unused_qualifications)]
66#[rustfmt::skip]
67#[path = "./generated/footer.rs"]
68/// A file format footer containing a serialized `vortex-file` Layout.
69///
70/// `footer.fbs`:
71/// ```flatbuffers
72#[doc = include_str!("../flatbuffers/vortex-file/footer.fbs")]
73/// ```
74pub mod footer;
75
76#[cfg(feature = "layout")]
77#[allow(clippy::all)]
78#[allow(clippy::derive_partial_eq_without_eq)]
79#[allow(clippy::many_single_char_names)]
80#[allow(clippy::unwrap_used)]
81#[allow(clippy::borrow_as_ptr)]
82#[allow(dead_code)]
83#[allow(non_snake_case)]
84#[allow(non_camel_case_types)]
85#[allow(unsafe_op_in_unsafe_fn)]
86#[allow(unused_imports)]
87#[allow(unused_lifetimes)]
88#[allow(unused_qualifications)]
89#[rustfmt::skip]
90#[path = "./generated/layout.rs"]
91/// A serialized sequence of arrays, each with its buffers.
92///
93/// `layout.fbs`:
94/// ```flatbuffers
95#[doc = include_str!("../flatbuffers/vortex-layout/layout.fbs")]
96/// ```
97pub mod layout;
98
99#[cfg(feature = "ipc")]
100#[allow(clippy::all)]
101#[allow(clippy::derive_partial_eq_without_eq)]
102#[allow(clippy::many_single_char_names)]
103#[allow(clippy::unwrap_used)]
104#[allow(clippy::borrow_as_ptr)]
105#[allow(dead_code)]
106#[allow(non_snake_case)]
107#[allow(non_camel_case_types)]
108#[allow(unsafe_op_in_unsafe_fn)]
109#[allow(unused_imports)]
110#[allow(unused_lifetimes)]
111#[allow(unused_qualifications)]
112#[rustfmt::skip]
113#[path = "./generated/message.rs"]
114/// A serialized sequence of arrays, each with its buffers.
115///
116/// `message.fbs`:
117/// ```flatbuffers
118#[doc = include_str!("../flatbuffers/vortex-serde/message.fbs")]
119/// ```
120pub mod message;
121
122use flatbuffers::{FlatBufferBuilder, Follow, InvalidFlatbuffer, Verifiable, WIPOffset, root};
123use vortex_buffer::{ByteBuffer, ConstByteBuffer};
124
125/// We define a const-aligned byte buffer for flatbuffers with 8-byte alignment.
126///
127/// This is based on the assumption that the maximum primitive type is 8 bytes.
128/// See: <https://groups.google.com/g/flatbuffers/c/PSgQeWeTx_g>
129pub type FlatBuffer = ConstByteBuffer<8>;
130
131pub trait FlatBufferRoot {}
132
133pub trait ReadFlatBuffer: Sized {
134    type Source<'a>: Verifiable + Follow<'a>;
135    type Error: From<InvalidFlatbuffer>;
136
137    fn read_flatbuffer<'buf>(
138        fb: &<Self::Source<'buf> as Follow<'buf>>::Inner,
139    ) -> Result<Self, Self::Error>;
140
141    fn read_flatbuffer_bytes<'buf>(bytes: &'buf [u8]) -> Result<Self, Self::Error>
142    where
143        <Self as ReadFlatBuffer>::Source<'buf>: 'buf,
144    {
145        let fb = root::<Self::Source<'buf>>(bytes)?;
146        Self::read_flatbuffer(&fb)
147    }
148}
149
150pub trait WriteFlatBuffer {
151    type Target<'a>;
152
153    fn write_flatbuffer<'fb>(
154        &self,
155        fbb: &mut FlatBufferBuilder<'fb>,
156    ) -> WIPOffset<Self::Target<'fb>>;
157}
158
159pub trait WriteFlatBufferExt: WriteFlatBuffer + FlatBufferRoot {
160    /// Write the flatbuffer into a [`FlatBuffer`].
161    fn write_flatbuffer_bytes(&self) -> FlatBuffer;
162}
163
164impl<F: WriteFlatBuffer + FlatBufferRoot> WriteFlatBufferExt for F {
165    fn write_flatbuffer_bytes(&self) -> FlatBuffer {
166        let mut fbb = FlatBufferBuilder::new();
167        let root_offset = self.write_flatbuffer(&mut fbb);
168        fbb.finish_minimal(root_offset);
169        let (vec, start) = fbb.collapse();
170        let end = vec.len();
171        FlatBuffer::align_from(ByteBuffer::from(vec).slice(start..end))
172    }
173}
vortex_flatbuffers/lib.rs

vortex_flatbuffers/
lib.rs
