Settings

Struct Settings 

Source
pub struct Settings<'a, 't, 'i> { /* private fields */ }

Implementations§

Source§

impl<'a, 't, 'i> Settings<'a, 't, 'i>

Source

pub fn new( wtxn: &'t mut RwTxn<'i>, index: &'i Index, indexer_config: &'a IndexerConfig, ) -> Settings<'a, 't, 'i>

Source

pub fn reset_searchable_fields(&mut self)

Source

pub fn set_searchable_fields(&mut self, names: Vec<String>)

Source

pub fn reset_displayed_fields(&mut self)

Source

pub fn set_displayed_fields(&mut self, names: Vec<String>)

Source

pub fn reset_filterable_fields(&mut self)

Source

pub fn set_filterable_fields(&mut self, rules: Vec<FilterableAttributesRule>)

Source

pub fn set_sortable_fields(&mut self, names: HashSet<String>)

Source

pub fn reset_sortable_fields(&mut self)

Source

pub fn reset_criteria(&mut self)

Source

pub fn set_criteria(&mut self, criteria: Vec<Criterion>)

Source

pub fn reset_stop_words(&mut self)

Source

pub fn set_stop_words(&mut self, stop_words: BTreeSet<String>)

Source

pub fn reset_non_separator_tokens(&mut self)

Source

pub fn set_non_separator_tokens( &mut self, non_separator_tokens: BTreeSet<String>, )

Source

pub fn reset_separator_tokens(&mut self)

Source

pub fn set_separator_tokens(&mut self, separator_tokens: BTreeSet<String>)

Source

pub fn reset_dictionary(&mut self)

Source

pub fn set_dictionary(&mut self, dictionary: BTreeSet<String>)

Source

pub fn reset_distinct_field(&mut self)

Source

pub fn set_distinct_field(&mut self, distinct_field: String)

Source

pub fn reset_synonyms(&mut self)

Source

pub fn set_synonyms(&mut self, synonyms: BTreeMap<String, Vec<String>>)

Source

pub fn reset_primary_key(&mut self)

Source

pub fn set_primary_key(&mut self, primary_key: String)

Source

pub fn set_autorize_typos(&mut self, val: bool)

Source

pub fn reset_authorize_typos(&mut self)

Source

pub fn set_min_word_len_two_typos(&mut self, val: u8)

Source

pub fn reset_min_word_len_two_typos(&mut self)

Source

pub fn set_min_word_len_one_typo(&mut self, val: u8)

Source

pub fn reset_min_word_len_one_typo(&mut self)

Source

pub fn set_disable_on_numbers(&mut self, disable_on_numbers: bool)

Source

pub fn reset_disable_on_numbers(&mut self)

Source

pub fn set_exact_words(&mut self, words: BTreeSet<String>)

Source

pub fn reset_exact_words(&mut self)

Source

pub fn set_exact_attributes(&mut self, attrs: HashSet<String>)

Source

pub fn reset_exact_attributes(&mut self)

Source

pub fn set_max_values_per_facet(&mut self, value: usize)

Source

pub fn reset_max_values_per_facet(&mut self)

Source

pub fn set_sort_facet_values_by(&mut self, value: OrderByMap)

Source

pub fn reset_sort_facet_values_by(&mut self)

Source

pub fn set_pagination_max_total_hits(&mut self, value: usize)

Source

pub fn reset_pagination_max_total_hits(&mut self)

Source

pub fn set_proximity_precision(&mut self, value: ProximityPrecision)

Source

pub fn reset_proximity_precision(&mut self)

Source

pub fn set_embedder_settings( &mut self, value: BTreeMap<String, Setting<EmbeddingSettings>>, )

Source

pub fn reset_embedder_settings(&mut self)

Source

pub fn set_search_cutoff(&mut self, value: u64)

Source

pub fn reset_search_cutoff(&mut self)

Source

pub fn set_localized_attributes_rules( &mut self, value: Vec<LocalizedAttributesRule>, )

Source

pub fn reset_localized_attributes_rules(&mut self)

Source

pub fn execute<FP, FA>( self, progress_callback: FP, should_abort: FA, ) -> Result<()>
where FP: Fn(UpdateIndexingStep) + Sync, FA: Fn() -> bool + Sync,

Auto Trait Implementations§

§

impl<'a, 't, 'i> Freeze for Settings<'a, 't, 'i>

§

impl<'a, 't, 'i> !RefUnwindSafe for Settings<'a, 't, 'i>

§

impl<'a, 't, 'i> Send for Settings<'a, 't, 'i>

§

impl<'a, 't, 'i> !Sync for Settings<'a, 't, 'i>

§

impl<'a, 't, 'i> Unpin for Settings<'a, 't, 'i>

§

impl<'a, 't, 'i> !UnwindSafe for Settings<'a, 't, 'i>

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, 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<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> Any for T
where T: Any,

Source§

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