Struct MemvidEncoder

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

Main encoder for creating QR code videos from text documents

Implementations§

Source§

impl MemvidEncoder

Source

pub async fn new(config: Option<Config>) -> Result<Self>

Create a new encoder with optional configuration

Source

pub async fn add_text( &mut self, text: &str, chunk_size: usize, overlap: usize, ) -> Result<()>

Add text content with custom chunk size and overlap

Source

pub async fn add_pdf<P: AsRef<Path>>(&mut self, pdf_path: P) -> Result<()>

Add PDF document content

Source

pub async fn add_text_file<P: AsRef<Path>>( &mut self, file_path: P, ) -> Result<()>

Add plain text file content

Source

pub async fn add_markdown_file<P: AsRef<Path>>( &mut self, file_path: P, ) -> Result<()>

Add markdown file content

Source

pub async fn build_video( &mut self, output_file: &str, index_file: &str, ) -> Result<EncodingStats>

Build video from chunks, generating embeddings if enabled

Source

pub async fn build_video_with_progress<F>( &mut self, output_file: &str, index_file: &str, progress_callback: F, ) -> Result<EncodingStats>
where F: Fn(f32),

Build video with progress callback

Source

pub fn clear(&mut self)

Clear all chunks

Source

pub fn get_stats(&self) -> EncodingStats

Get encoding statistics

Source

pub fn chunk_count(&self) -> usize

Get current chunk count

Source

pub fn config(&self) -> &Config

Get configuration

Source

pub fn add_chunks(&mut self, chunks: Vec<String>) -> Result<()>

Add pre-chunked text content directly

Source

pub fn has_embeddings(&self) -> bool

Check if embeddings are enabled (always true)

Source

pub async fn append_chunks( &mut self, existing_video_file: &str, existing_index_file: &str, new_chunks: Vec<String>, ) -> Result<EncodingStats>

Append new chunks to an existing video and database (INCREMENTAL UPDATE) This is the core functionality for personal knowledge base use cases

Source

pub async fn append_conversation_history( &mut self, existing_video_file: &str, existing_index_file: &str, conversations: Vec<(String, String)>, ) -> Result<EncodingStats>

Append chunks from LLM conversation history Specialized for the LLM conversation use case

Source

pub async fn append_document_chunks( &mut self, existing_video_file: &str, existing_index_file: &str, document_path: &str, ) -> Result<EncodingStats>

Append chunks from document processing Specialized for the document indexing use case

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
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<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<U, <U as TryFrom<T>>::Error>> + 'async_trait>>
where T: 'async_trait,

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> ErasedDestructor for T
where T: 'static,