Struct tantivy::directory::ReadOnlySource

pub struct ReadOnlySource { /* fields omitted */ }

Read object that represents files in tantivy.

These read objects are only in charge to deliver the data in the form of a constant read-only &[u8]. Whatever happens to the directory file, the data hold by this object should never be altered or destroyed.

Methods

impl ReadOnlySource

pub fn empty() -> ReadOnlySource

Creates an empty ReadOnlySource

pub fn as_slice(&self) -> &[u8]

Returns the data underlying the ReadOnlySource object.

pub fn split(self, addr: usize) -> (ReadOnlySource, ReadOnlySource)

Splits into 2 ReadOnlySource, at the offset given as an argument.

pub fn slice(&self, start: usize, stop: usize) -> ReadOnlySource

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

Keep in mind that any living slice extends the lifetime of the original ReadOnlySource,

For instance, if ReadOnlySource wraps 500MB worth of data in anonymous memory, and only a 1KB slice is remaining, the whole 500MBs are retained in memory.

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

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

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

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

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

Equivalent to .slice(0, to_offset)

Trait Implementations

impl HasLen for ReadOnlySource

fn len(&self) -> usize

Return length

fn is_empty(&self) -> bool

Returns true iff empty.

impl From<Arc<Box<dyn Deref<Target = [u8]> + 'static + Sync + Send>>> for ReadOnlySource

fn from(
    data: Arc<Box<dyn Deref<Target = [u8]> + Send + Sync + 'static>>
) -> Self

Performs the conversion.

impl From<Vec<u8>> for ReadOnlySource

fn from(data: Vec<u8>) -> ReadOnlySource

Performs the conversion.

impl Clone for ReadOnlySource

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ReadOnlySource

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl StableDeref for ReadOnlySource

impl CloneStableDeref for ReadOnlySource