Skip to main content

IndexReport

Struct IndexReport 

Source
pub struct IndexReport {
Show 34 fields pub scanned: usize, pub indexed: usize, pub unchanged: usize, pub skipped: usize, pub removed: usize, pub chunks: usize, pub remaining: usize, pub pending: Vec<PathBuf>, pub generated: Vec<String>, pub rechunked: bool, pub refused: Vec<(String, String)>, pub failed: Vec<(String, String)>, pub skipped_reasons: BTreeMap<String, usize>, pub secrets_indexed: usize, pub dummies_indexed: usize, pub accepted_indexed: usize, pub symbols: usize, pub edges: usize, pub images: usize, pub stopped: bool, pub threads: usize, pub embedded: usize, pub batched: usize, pub lanes: BTreeMap<String, usize>, pub bytes: u64, pub bytes_total: u64, pub written: Vec<String>, pub stages: Stages, pub cache_lookups: usize, pub cache_hits: usize, pub rows: usize, pub expected_left: u64, pub images_left: usize, pub images_flight: usize, /* private fields */
}

Fields§

§scanned: usize§indexed: usize§unchanged: usize§skipped: usize§removed: usize§chunks: usize§remaining: usize

Paths a time-bounded run never reached. Zero unless a budget cut the run short — an unbounded index_paths always finishes what it walked.

§pending: Vec<PathBuf>

Exactly the paths this slice did not reach, in the order it would have taken them.

The next slice indexes these rather than walking the roots again. A re-walk is not merely wasted directory traversal: every file the run had already done is re-opened and re-hashed to discover it is unchanged, so a run of N files over S slices read N×S files instead of N, and the progress a page drew restarted from one on every slice. The content hashes made it correct to re-walk, which is why it went unnoticed.

§generated: Vec<String>

Generated or vendored directories the walk stepped over — node_modules, a target beside a Cargo.toml, and the rest of the default-ignore table.

Named rather than counted in files, because pruning the subtree is the point and counting what is inside it would undo the saving to report it. A person looking for a file that is not in their store needs the name of the directory that was stepped over, which is what this gives them.

§rechunked: bool

Whether this pass re-embedded files nothing on disk had changed, because the store was written by a release that showed the embedding model less than this one does.

A user whose unchanged repository suddenly indexes from scratch is owed the reason, and the reason is a property of the run rather than of any one file — so it is reported here and said once, not per file.

§refused: Vec<(String, String)>

Paths refused, each with the rule that refused it.

Listed rather than counted: “three paths were refused” is not something an agent or a person can act on, and a refusal that is not named reads as a file that quietly failed to index.

§failed: Vec<(String, String)>

Paths that failed on their own content, each with what failed.

Listed like refused, and for the same reason: a count of failures is a number somebody has to go and investigate, and this release exists because those investigations had nothing to go on.

§skipped_reasons: BTreeMap<String, usize>

How many files were skipped for each reason, by kind.

§secrets_indexed: usize

Files the content scan would have refused and --include-secrets indexed anyway. Reported so that the flag is never silent about what it did: a store that holds credentials should say how many.

§dummies_indexed: usize

Files indexed whose every secret-shaped match was a declared test dummy.

§accepted_indexed: usize

Files indexed because a person accepted them, in their accepted mode.

§symbols: usize

Symbols extracted in this run, and the edges between them.

§edges: usize§images: usize

Images embedded in this run.

§stopped: bool

Whether the run was stopped rather than finished.

§threads: usize

The intra-op thread count the session ran with at the end of this call, or 0 when nothing was embedded.

§embedded: usize

Chunks embedded so far in this call, counted per batch. chunks counts finished files, so it stands still through a large one; this does not.

§batched: usize

Chunks whose batch has come back from a device, ahead of their window landing: what progress moves on while the writer waits.

§lanes: BTreeMap<String, usize>

Chunks each lane has embedded for this store, since it was opened.

§bytes: u64§bytes_total: u64§written: Vec<String>

Every file this call embedded, in order. The caller keeps these across the slices of one logical run, so stopping can undo the whole run rather than only the slice that happened to be going.

§stages: Stages

Where this call’s wall time went, stage by stage.

§cache_lookups: usize

Chunks the machine-wide vector cache was asked for, and held.

§cache_hits: usize§rows: usize

Chunk rows this call wrote, embedded or not yet: what embedded is catching up with, and what a card’s pending share is taken from.

§expected_left: u64

The chunks and images expected from the files this call has not reached yet: the estimate a continuation slice starts from.

§images_left: usize§images_flight: usize

Images with the image lane: read, not embedded yet. Counted in the total, or the total dropped by each one sent and rose as it landed.

Trait Implementations§

Source§

impl Clone for IndexReport

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IndexReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IndexReport

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Serialize for IndexReport

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V