Struct ChunkTextBuilder

pub struct ChunkTextBuilder { /* private fields */ }

Builder for ChunkText.

Implementations

impl ChunkTextBuilder

pub fn concurrency(&mut self, value: usize) -> &mut Self

The max number of concurrent chunks to process.

Defaults to None. If you use a splitter that is resource heavy, this parameter can be tuned.

pub fn max_characters(&mut self, value: usize) -> &mut Self

Optional maximum number of characters per chunk.

Defaults to [DEFAULT_MAX_CHAR_SIZE].

pub fn range(&mut self, value: Range<usize>) -> &mut Self

A range of minimum and maximum characters per chunk.

Chunks smaller than the range min will be ignored. max_characters will be ignored if this is set.

If you provide a custom chunker with a range, you might want to set the range as well.

Defaults to 0..[max_characters]

pub fn chunker<VALUE: Into<Arc<TextSplitter<Characters>>>>( &mut self, value: VALUE, ) -> &mut Self

The text splitter from text_splitter

Defaults to a new TextSplitter with the specified max_characters.

pub fn build(&self) -> Result<ChunkText, ChunkTextBuilderError>

Builds a new ChunkText.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ChunkTextBuilder

fn clone(&self) -> ChunkTextBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ChunkTextBuilder

fn default() -> Self

Returns the “default value” for a type.