Struct SearchIndex 

pub struct SearchIndex {
    pub entries: Vec<SearchEntry>,
}

The complete search index written to search-index.json.

Fields

entries: Vec<SearchEntry>

All indexed pages.

Implementations

impl SearchIndex

pub fn build(site_dir: &Path) -> Result<Self, SsgError>

Build a search index from all HTML files in site_dir.

Walks the directory recursively, extracts content from each .html file, and returns the populated index.

Examples

use ssg::search::SearchIndex;
use tempfile::tempdir;

let dir = tempdir().unwrap();
// Empty dir ⇒ empty index, never an error.
let idx = SearchIndex::build(dir.path()).unwrap();
assert!(idx.is_empty());

pub fn write(&self, site_dir: &Path) -> Result<(), SsgError>

Write the index to search-index.json in the given directory.

Examples

use ssg::search::SearchIndex;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let idx = SearchIndex::build(dir.path()).unwrap();
idx.write(dir.path()).unwrap();
assert!(dir.path().join("search-index.json").exists());

pub const fn len(&self) -> usize

Number of indexed pages.

Examples

use ssg::search::SearchIndex;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let idx = SearchIndex::build(dir.path()).unwrap();
assert_eq!(idx.len(), 0);

pub const fn is_empty(&self) -> bool

Returns true if the index has no entries.

Examples

use ssg::search::SearchIndex;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let idx = SearchIndex::build(dir.path()).unwrap();
assert!(idx.is_empty());

Trait Implementations

impl Clone for SearchIndex

fn clone(&self) -> SearchIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchIndex

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

Formats the value using the given formatter.

impl Default for SearchIndex

fn default() -> SearchIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.