Struct tantivy::SnippetGenerator [−][src]
SnippetGenerator
Example
use tantivy::SnippetGenerator; // ... let query = query_parser.parse_query("haleurs flamands").unwrap(); let mut snippet_generator = SnippetGenerator::create(&searcher, &*query, text_field)?; snippet_generator.set_max_num_chars(100); let snippet = snippet_generator.snippet_from_doc(&doc); let snippet_html: String = snippet.to_html(); assert_eq!(snippet_html, "Comme je descendais des Fleuves impassibles,\n Je ne me sentis plus guidé par les <b>haleurs</b> :\n Des");
Implementations
impl SnippetGenerator
[src]
pub fn create(
searcher: &Searcher,
query: &dyn Query,
field: Field
) -> Result<SnippetGenerator>
[src]
searcher: &Searcher,
query: &dyn Query,
field: Field
) -> Result<SnippetGenerator>
Creates a new snippet generator
pub fn set_max_num_chars(&mut self, max_num_chars: usize)
[src]
Sets a maximum number of chars.
pub fn snippet_from_doc(&self, doc: &Document) -> Snippet
[src]
Generates a snippet for the given Document
.
This method extract the text associated to the SnippetGenerator
's field
and computes a snippet.
pub fn snippet(&self, text: &str) -> Snippet
[src]
Generates a snippet for the given text.
Auto Trait Implementations
impl !RefUnwindSafe for SnippetGenerator
[src]
impl Send for SnippetGenerator
[src]
impl Sync for SnippetGenerator
[src]
impl Unpin for SnippetGenerator
[src]
impl !UnwindSafe for SnippetGenerator
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Downcast for T where
T: Any,
[src]
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
[src]
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
[src]
pub fn as_any(&self) -> &(dyn Any + 'static)
[src]
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
[src]
impl<T> DowncastSync for T where
T: Send + Sync + Any,
[src]
T: Send + Sync + Any,
impl<T> From<T> for T
[src]
impl<T> Fruit for T where
T: Send + Downcast,
[src]
T: Send + Downcast,
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,