Struct MtmdBatch 

pub struct MtmdBatch<'ctx> { /* private fields */ }

Encode several media chunks in one pass.

MtmdContext::encode_chunk handles one chunk at a time; this batches them, which is what you want for a multi-image prompt or a run of video frames — the vision encoder runs once over the whole set instead of once per image.

A batch belongs to the context that created it and borrows it for its lifetime. Chunks are not owned by the batch, so they must outlive it too.

Wraps mtmd_batch_init / mtmd_batch_add_chunk / mtmd_batch_encode.

Implementations

impl<'ctx> MtmdBatch<'ctx>

pub fn new(ctx: &'ctx MtmdContext) -> Result<Self>

Start a batch against ctx.

Errors

Returns MtmdError::BatchCreateFailed if llama.cpp returns null.

pub fn add_chunk(&mut self, chunk: &MtmdInputChunk<'_>) -> Result<()>

Add a media chunk. Text chunks are rejected.

Errors

Returns MtmdError::BatchAddFailed — code 2 means the batch is full and the chunk was not added (start a new batch), code 3 means it cannot be batched with what is already there (differing image geometry, say).

pub fn encode(&mut self) -> Result<()>

Encode every chunk added so far.

Errors

Returns MtmdError::EncodeError on failure.

pub fn output_embd( &self, chunk: &MtmdInputChunk<'_>, n_embd: usize, ) -> Option<&[f32]>

Borrow the embeddings produced for chunk by the last Self::encode.

Returns None if the chunk was not part of this batch or encoding has not run. The slice is owned by the batch and is invalidated by the next encode.

Safety of the returned length

llama.cpp reports only a pointer, so the length is derived from the chunk’s token count and the context’s embedding dimension.

Trait Implementations

impl Debug for MtmdBatch<'_>

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

Formats the value using the given formatter.

impl Drop for MtmdBatch<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.