Struct IndexResult

Source

pub struct IndexResult {
    pub doc_id: String,
    pub name: String,
    pub format: DocumentFormat,
    pub source_path: Option<PathBuf>,
    pub tree: Option<DocumentTree>,
    pub description: Option<String>,
    pub page_count: Option<usize>,
    pub line_count: Option<usize>,
    pub metrics: IndexMetrics,
    pub summary_cache: SummaryCache,
}

Expand description

Final result from the index pipeline.

Fields§

§doc_id: String

Document ID.

§name: String

Document name.

§format: DocumentFormat

Document format.

§source_path: Option<PathBuf>

Source file path.

§tree: Option<DocumentTree>

Built document tree.

§description: Option<String>

Document description.

§page_count: Option<usize>

Page count (for PDFs).

§line_count: Option<usize>

Line count.

§metrics: IndexMetrics

Performance metrics.

§summary_cache: SummaryCache

Summary cache.

Implementations§

Source §

impl IndexResult

Source

pub fn has_tree(&self) -> bool

Check if the result has a tree.

Source

pub fn tree(&self) -> Option<&DocumentTree>

Get the tree.

Source

pub fn total_time_ms(&self) -> u64

Get total indexing time in milliseconds.

Trait Implementations§

Source §

impl Debug for IndexResult

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for IndexResult

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more

Source §