pub struct MemoryBackend { /* private fields */ }Expand description
In-memory FTS backend backed by HashMaps keyed by
(database_id, tid, collection, field, …) tuples.
Uses RefCell for interior mutability so the FtsBackend trait
can use &self uniformly (redb has its own transactional isolation).
Implementations§
Source§impl MemoryBackend
impl MemoryBackend
pub fn new() -> MemoryBackend
Trait Implementations§
Source§impl Debug for MemoryBackend
impl Debug for MemoryBackend
Source§impl Default for MemoryBackend
impl Default for MemoryBackend
Source§fn default() -> MemoryBackend
fn default() -> MemoryBackend
Source§impl FtsBackend for MemoryBackend
impl FtsBackend for MemoryBackend
Source§type Error = MemoryError
type Error = MemoryError
Source§fn read_postings(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
term: &str,
) -> Result<Vec<Posting>, <MemoryBackend as FtsBackend>::Error>
fn read_postings( &self, database_id: u64, tid: u64, index: IndexScope<'_>, term: &str, ) -> Result<Vec<Posting>, <MemoryBackend as FtsBackend>::Error>
Source§fn write_postings(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
term: &str,
postings: &[Posting],
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn write_postings( &self, database_id: u64, tid: u64, index: IndexScope<'_>, term: &str, postings: &[Posting], ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn upsert_posting(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
term: &str,
posting: &Posting,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn upsert_posting( &self, database_id: u64, tid: u64, index: IndexScope<'_>, term: &str, posting: &Posting, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn remove_posting(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
term: &str,
doc_id: Surrogate,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn remove_posting( &self, database_id: u64, tid: u64, index: IndexScope<'_>, term: &str, doc_id: Surrogate, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn remove_postings(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
term: &str,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn remove_postings( &self, database_id: u64, tid: u64, index: IndexScope<'_>, term: &str, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn read_doc_length(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
doc_id: Surrogate,
) -> Result<Option<u32>, <MemoryBackend as FtsBackend>::Error>
fn read_doc_length( &self, database_id: u64, tid: u64, index: IndexScope<'_>, doc_id: Surrogate, ) -> Result<Option<u32>, <MemoryBackend as FtsBackend>::Error>
Source§fn write_doc_length(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
doc_id: Surrogate,
length: u32,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn write_doc_length( &self, database_id: u64, tid: u64, index: IndexScope<'_>, doc_id: Surrogate, length: u32, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn remove_doc_length(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
doc_id: Surrogate,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn remove_doc_length( &self, database_id: u64, tid: u64, index: IndexScope<'_>, doc_id: Surrogate, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn collection_terms(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
) -> Result<Vec<String>, <MemoryBackend as FtsBackend>::Error>
fn collection_terms( &self, database_id: u64, tid: u64, index: IndexScope<'_>, ) -> Result<Vec<String>, <MemoryBackend as FtsBackend>::Error>
Source§fn collection_stats(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
) -> Result<(u32, u64), <MemoryBackend as FtsBackend>::Error>
fn collection_stats( &self, database_id: u64, tid: u64, index: IndexScope<'_>, ) -> Result<(u32, u64), <MemoryBackend as FtsBackend>::Error>
(doc_count, total_token_sum). Read moreSource§fn increment_stats(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
doc_len: u32,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn increment_stats( &self, database_id: u64, tid: u64, index: IndexScope<'_>, doc_len: u32, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
doc_len is the number of tokens in the newly indexed document.Source§fn decrement_stats(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
doc_len: u32,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn decrement_stats( &self, database_id: u64, tid: u64, index: IndexScope<'_>, doc_len: u32, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
doc_len is the token count of the removed document.Source§fn read_meta(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
subkey: &str,
) -> Result<Option<Vec<u8>>, <MemoryBackend as FtsBackend>::Error>
fn read_meta( &self, database_id: u64, tid: u64, index: IndexScope<'_>, subkey: &str, ) -> Result<Option<Vec<u8>>, <MemoryBackend as FtsBackend>::Error>
Source§fn write_meta(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
subkey: &str,
value: &[u8],
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn write_meta( &self, database_id: u64, tid: u64, index: IndexScope<'_>, subkey: &str, value: &[u8], ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn write_segment(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
segment_id: &str,
data: &[u8],
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn write_segment( &self, database_id: u64, tid: u64, index: IndexScope<'_>, segment_id: &str, data: &[u8], ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
segment_id is a stable per-index
identifier (e.g., "L{level}:{id:016x}").Source§fn read_segment(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
segment_id: &str,
) -> Result<Option<Vec<u8>>, <MemoryBackend as FtsBackend>::Error>
fn read_segment( &self, database_id: u64, tid: u64, index: IndexScope<'_>, segment_id: &str, ) -> Result<Option<Vec<u8>>, <MemoryBackend as FtsBackend>::Error>
Source§fn list_segments(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
) -> Result<Vec<String>, <MemoryBackend as FtsBackend>::Error>
fn list_segments( &self, database_id: u64, tid: u64, index: IndexScope<'_>, ) -> Result<Vec<String>, <MemoryBackend as FtsBackend>::Error>
Source§fn remove_segment(
&self,
database_id: u64,
tid: u64,
index: IndexScope<'_>,
segment_id: &str,
) -> Result<(), <MemoryBackend as FtsBackend>::Error>
fn remove_segment( &self, database_id: u64, tid: u64, index: IndexScope<'_>, segment_id: &str, ) -> Result<(), <MemoryBackend as FtsBackend>::Error>
Source§fn purge_collection(
&self,
database_id: u64,
tid: u64,
collection: &str,
) -> Result<usize, <MemoryBackend as FtsBackend>::Error>
fn purge_collection( &self, database_id: u64, tid: u64, collection: &str, ) -> Result<usize, <MemoryBackend as FtsBackend>::Error>
Source§fn purge_tenant(
&self,
database_id: u64,
tid: u64,
) -> Result<usize, <MemoryBackend as FtsBackend>::Error>
fn purge_tenant( &self, database_id: u64, tid: u64, ) -> Result<usize, <MemoryBackend as FtsBackend>::Error>
(database_id, tid) across every collection.
Returns count of removed entries. Implementations MUST use a structural
drop (e.g., tuple range (db, tid, ..)..(db, tid+1, ..)) rather than a
lexical-prefix scan.Auto Trait Implementations§
impl !Freeze for MemoryBackend
impl !RefUnwindSafe for MemoryBackend
impl !Sync for MemoryBackend
impl Send for MemoryBackend
impl Unpin for MemoryBackend
impl UnsafeUnpin for MemoryBackend
impl UnwindSafe for MemoryBackend
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out indicating that a T is niched.Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);Source§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.