Struct SearchHit 

#[non_exhaustive]
pub struct SearchHit {
    pub relative_path: Utf8PathBuf,
    pub path: Utf8PathBuf,
    pub name: Option<String>,
}

One matching recipe.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

relative_path: Utf8PathBuf

Where the recipe sits under the search root.

This is SearchHit::path with the root stripped off, and is what cook search prints. A path that does not begin with the root is kept whole rather than mangled; see path for when that happens.

path: Utf8PathBuf

The path the search found the recipe at, ready to open.

Absolute when the search root is absolute, which is the case worth designing for. When the root is relative the path is too, and is interpreted against the process working directory — for an in-process editor integration that is the editor’s, not the project’s. This mirrors the caveat on Context::base_path and is the reason a relative root can leave relative_path and path equal.

name: Option<String>

The recipe’s title, falling back to its file stem when it has none.

Read from front matter that the search has already parsed, so it costs nothing to carry. None only if the entry has neither, which a file found on disk cannot manage.

Trait Implementations

impl Clone for SearchHit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchHit

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

Formats the value using the given formatter.

impl Serialize for SearchHit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.