Skip to main content

Chunker

Struct Chunker 

Source
pub struct Chunker { /* private fields */ }
Expand description

Text chunker with configurable strategy and parameters.

§Example

use pdfvec::{Chunker, ChunkStrategy};

let chunker = Chunker::new(ChunkStrategy::Fixed)
    .chunk_size(512)
    .overlap(50);

let text = "Your document text here...";
let chunks: Vec<_> = chunker.chunks(text).collect();

Implementations§

Source§

impl Chunker

Source

pub fn new(strategy: ChunkStrategy) -> Self

Creates a new chunker with the specified strategy.

§Example
use pdfvec::{Chunker, ChunkStrategy};

let chunker = Chunker::new(ChunkStrategy::Paragraph);
Source

pub fn chunk_size(self, size: usize) -> Self

Sets the target chunk size in characters.

For ChunkStrategy::Fixed, this is the exact size (except for the last chunk). For other strategies, this is the target size for merging small segments.

Default: 512

§Example
use pdfvec::{Chunker, ChunkStrategy};

let chunker = Chunker::new(ChunkStrategy::Fixed).chunk_size(1024);
Source

pub fn overlap(self, chars: usize) -> Self

Sets the overlap between consecutive chunks in characters.

Overlap helps maintain context across chunk boundaries. Only applies to ChunkStrategy::Fixed.

Default: 0

§Example
use pdfvec::{Chunker, ChunkStrategy};

let chunker = Chunker::new(ChunkStrategy::Fixed)
    .chunk_size(100)
    .overlap(20);
Source

pub fn min_chunk_size(self, size: usize) -> Self

Sets the minimum chunk size for paragraph and sentence strategies.

Chunks smaller than this will be merged with adjacent chunks.

Default: 100

§Example
use pdfvec::{Chunker, ChunkStrategy};

let chunker = Chunker::new(ChunkStrategy::Paragraph)
    .min_chunk_size(50);
Source

pub fn chunks<'a>( &self, text: &'a str, ) -> Box<dyn Iterator<Item = Chunk<'a>> + 'a>

Returns an iterator over chunks of the input text.

§Example
use pdfvec::{Chunker, ChunkStrategy};

let text = "Hello world. How are you?";
let chunker = Chunker::new(ChunkStrategy::Sentence);

for chunk in chunker.chunks(text) {
    println!("Chunk {}: {}", chunk.index(), chunk.text());
}
Source

pub fn get_chunk_size(&self) -> usize

Returns the configured chunk size.

Source

pub fn get_overlap(&self) -> usize

Returns the configured overlap.

Source

pub fn strategy(&self) -> ChunkStrategy

Returns the configured strategy.

Trait Implementations§

Source§

impl Clone for Chunker

Source§

fn clone(&self) -> Chunker

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Chunker

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Chunker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.