Struct tantivy::directory::FileSlice

pub struct FileSlice { /* private fields */ }

Logical slice of read only file in tantivy.

It can be cloned and sliced cheaply.

Implementations

impl FileSlice

pub fn stream_file_chunks( &self ) -> impl Iterator<Item = Result<OwnedBytes, Error>>

impl FileSlice

pub fn new(file_handle: Arc<dyn FileHandle>) -> FileSlice

Wraps a FileHandle.

pub fn slice<R>(&self, byte_range: R) -> FileSlice

where R: RangeBounds<usize>,

Creates a fileslice that is just a view over a slice of the data.

Panics

Panics if byte_range.end exceeds the filesize.

pub fn empty() -> FileSlice

Creates an empty FileSlice

pub fn read_bytes(&self) -> Result<OwnedBytes, Error>

Returns a OwnedBytes with all of the data in the FileSlice.

The behavior is strongly dependent on the implementation of the underlying Directory and the FileSliceTrait it creates. In particular, it is up to the Directory implementation to handle caching if needed.

pub fn read_bytes_slice(&self, range: Range<usize>) -> Result<OwnedBytes, Error>

Reads a specific slice of data.

This is equivalent to running file_slice.slice(from, to).read_bytes().

pub fn split(self, left_len: usize) -> (FileSlice, FileSlice)

Splits the FileSlice at the given offset and return two file slices. file_slice[..split_offset] and file_slice[split_offset..].

This operation is cheap and must not copy any underlying data.

pub fn split_from_end(self, right_len: usize) -> (FileSlice, FileSlice)

Splits the file slice at the given offset and return two file slices. file_slice[..split_offset] and file_slice[split_offset..].

pub fn slice_from(&self, from_offset: usize) -> FileSlice

Like .slice(...) but enforcing only the from boundary.

Equivalent to .slice(from_offset, self.len())

pub fn slice_from_end(&self, from_offset: usize) -> FileSlice

Returns a slice from the end.

Equivalent to .slice(self.len() - from_offset, self.len())

pub fn slice_to(&self, to_offset: usize) -> FileSlice

Like .slice(...) but enforcing only the to boundary.

Equivalent to .slice(0, to_offset)

pub fn num_bytes(&self) -> ByteCount

Returns the byte count of the FileSlice.

Trait Implementations

impl Clone for FileSlice

fn clone(&self) -> FileSlice

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileSlice

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FileHandle for FileSlice

fn read_bytes(&self, range: Range<usize>) -> Result<OwnedBytes, Error>

Reads a slice of bytes.

impl<B> From<B> for FileSlice

where B: StableDeref<Target = [u8]> + Deref + 'static + Send + Sync,

fn from(bytes: B) -> FileSlice

Converts to this type from the input type.

impl HasLen for FileSlice

fn len(&self) -> usize

Return length

fn is_empty(&self) -> bool

Returns true iff empty.