Struct text_splitter::ChunkSize

pub struct ChunkSize { /* private fields */ }

Result returned from a ChunkSizer. Includes the size of the chunk, in units determined by the sizer, as well as the max byte offset of the text that would fit within the given ChunkCapacity.

Implementations

impl ChunkSize

pub fn from_size(size: usize, capacity: &ChunkCapacity) -> Self

Generate a chunk size from a given size. Will not be able to compute the max byte offset that fits within the capacity.

pub fn from_offsets( offsets: impl Iterator<Item = Range<usize>>, capacity: &ChunkCapacity ) -> Self

Generate a chunk size from an iterator of byte ranges for each encoded element in the chunk.

pub fn fits(&self) -> Ordering

Determine whether the chunk size fits within the capacity or not

pub fn size(&self) -> usize

Size of the chunk, in units used by the sizer.

Trait Implementations

impl Clone for ChunkSize

fn clone(&self) -> ChunkSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChunkSize

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

Formats the value using the given formatter.

impl PartialEq for ChunkSize

fn eq(&self, other: &ChunkSize) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ChunkSize

impl StructuralPartialEq for ChunkSize