Trait text_splitter::ChunkCapacity

pub trait ChunkCapacity {
    // Required method
    fn end(&self) -> usize;

    // Provided methods
    fn start(&self) -> Option<usize> { ... }
    fn fits(&self, chunk_size: usize) -> Ordering { ... }
}

Describes the largest valid chunk size(s) that can be generated.

An end size is required, which is the maximum possible chunk size that can be generated.

A start size is optional. By specifying start and end it means a range of sizes will be considered valid. Once a chunk has reached a length that falls between start and end it will be returned.

It is always possible that a chunk may be returned that is less than the start value, as adding the next piece of text may have made it larger than the end capacity.

Required Methods

fn end(&self) -> usize

The maximum size that a chunk can be.

Provided Methods

fn start(&self) -> Option<usize>

An optional start value. If both start and end are specified, a valid chunk can fall anywhere between the two values (inclusive).

fn fits(&self, chunk_size: usize) -> Ordering

Validate if a given chunk fits within the capacity

• Ordering::Less indicates more could be added
• Ordering::Equal indicates the chunk is within the capacity range
• Ordering::Greater indicates the chunk is larger than the capacity

Implementations on Foreign Types

impl ChunkCapacity for usize

fn end(&self) -> usize

impl ChunkCapacity for Range<usize>

fn start(&self) -> Option<usize>

fn end(&self) -> usize

impl ChunkCapacity for RangeFrom<usize>

fn start(&self) -> Option<usize>

fn end(&self) -> usize

impl ChunkCapacity for RangeFull

fn start(&self) -> Option<usize>

fn end(&self) -> usize

impl ChunkCapacity for RangeInclusive<usize>

fn start(&self) -> Option<usize>

fn end(&self) -> usize

impl ChunkCapacity for RangeTo<usize>

fn start(&self) -> Option<usize>

fn end(&self) -> usize

impl ChunkCapacity for RangeToInclusive<usize>

fn start(&self) -> Option<usize>

fn end(&self) -> usize

Implementors