Skip to main content

EmbedderStack

frankensearch_embed::auto_detect

Struct EmbedderStack 

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

Resolved fast/quality embedder stack for progressive search.

Implementations§

Source§

impl EmbedderStack

Source

pub fn from_parts( fast: Arc<dyn Embedder>, quality: Option<Arc<dyn Embedder>>, ) -> Self

Build from explicit parts.

Source

pub fn auto_detect() -> SearchResult<Self>

Auto-detect best available embedders from default search paths.

§Errors

Returns SearchError::EmbedderUnavailable when no usable fast embedder is available.

Source

pub fn auto_detect_with(model_root: Option<&Path>) -> SearchResult<Self>

Auto-detect embedders with an optional explicit model root override.

§Errors

Returns SearchError::EmbedderUnavailable when no usable fast embedder is available.

Source

pub fn with_mrl_target_dim(self, target_dim: usize) -> SearchResult<Self>

Apply MRL-style dimensionality reduction where supported.

§Errors

Returns SearchError::InvalidConfig when target_dim is zero.

Source

pub fn fast(&self) -> &dyn Embedder

Fast embedder reference.

Source

pub fn fast_embedder(&self) -> &dyn Embedder

Fast embedder alias for API compatibility.

Source

pub fn fast_arc(&self) -> Arc<dyn Embedder>

Cloned fast embedder handle.

Source

pub fn quality(&self) -> Option<&dyn Embedder>

Optional quality embedder reference.

Source

pub fn quality_embedder(&self) -> Option<&dyn Embedder>

Optional quality embedder alias for API compatibility.

Source

pub fn quality_arc(&self) -> Option<Arc<dyn Embedder>>

Cloned quality embedder handle.

Source

pub const fn availability(&self) -> TwoTierAvailability

Availability state.

Source

pub fn diagnose(&self) -> ModelAvailabilityDiagnostic

Generate a user-facing diagnostic report about model availability.

Includes actionable suggestions for resolving degraded states: cache directory paths, manual download URLs, environment variable hints.

Source

pub fn degradation_message(&self) -> Option<String>

Returns a user-facing message if operating in a degraded mode, or None if fully available.

Trait Implementations§

Source§

impl Clone for EmbedderStack

Source§

fn clone(&self) -> EmbedderStack

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmbedderStack

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> 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.
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