pub struct Search {
pub enable: bool,
pub limit_results: u32,
pub teaser_word_count: u32,
pub use_boolean_and: bool,
pub boost_title: u8,
pub boost_hierarchy: u8,
pub boost_paragraph: u8,
pub expand: bool,
pub heading_split_level: u8,
pub copy_js: bool,
}
Expand description
Configuration of the search functionality of the HTML renderer.
Fields
enable: bool
Enable the search feature. Default: true
.
limit_results: u32
Maximum number of visible results. Default: 30
.
The number of words used for a search result teaser. Default: 30
.
use_boolean_and: bool
Define the logical link between multiple search words.
If true, all search words must appear in each result. Default: false
.
boost_title: u8
Boost factor for the search result score if a search word appears in the header.
Default: 2
.
boost_hierarchy: u8
Boost factor for the search result score if a search word appears in the hierarchy.
The hierarchy contains all titles of the parent documents and all parent headings.
Default: 1
.
boost_paragraph: u8
Boost factor for the search result score if a search word appears in the text.
Default: 1
.
expand: bool
True if the searchword micro
should match microwave
. Default: true
.
heading_split_level: u8
Documents are split into smaller parts, separated by headings. This defines, until which
level of heading documents should be split. Default: 3
. (### This is a level 3 heading
)
copy_js: bool
Copy JavaScript files for the search functionality to the output directory?
Default: true
.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Search where
Search: Default,
impl<'de> Deserialize<'de> for Search where
Search: Default,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for Search
Auto Trait Implementations
impl RefUnwindSafe for Search
impl Send for Search
impl Sync for Search
impl Unpin for Search
impl UnwindSafe for Search
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more