Struct OutOfLineBuffers

pub struct OutOfLineBuffers { /* private fields */ }

A tool to reserve space for buffers that are not in-line with the data

In most cases, buffers are stored in the page and referred to in the encoding metadata by their index in the page. This keeps all buffers within a page together. As a result, most encoders should not need to use this structure.

In some cases (currently only the large binary encoding) there is a need to access buffers that are not in the page (because storing the position / offset of every page in the page metadata would be too expensive).

To do this you can add a buffer with add_buffer and then use the returned position in some way (in the large binary encoding the returned position is stored in the page data as a position / size array).

Implementations

impl OutOfLineBuffers

pub fn new(base_position: u64, buffer_alignment: u64) -> Self

pub fn add_buffer(&mut self, buffer: LanceBuffer) -> u64

pub fn take_buffers(self) -> Vec<LanceBuffer>

pub fn reset_position(&mut self, position: u64)