1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use ;
use crateContentPath;
use crateExtractionContext;
use crateFindingMetadata;
use crateNoMetadata;
use crateOwnedContentPtr;
/// Return value used by analyzers to steer the scan.
///
/// [`ContentAnalyzer::analyze`] returns a `AnalysisOutcome` that tells the
/// scanner whether to continue this object, skip the rest of it,
/// abort the entire scan, or reprocess the same object as another
/// type. [`ContentExtractor`] and
/// [`ExtractionSession`] methods do not return this type: they yield
/// [`Option`] at each session step.
/// Metadata for a single entry produced by a [`ContentExtractor`].
///
/// An [`ExtractionSession`] advertises the next item it is about to
/// extract via this struct. The scanner uses it to apply
/// [`Filter`](crate::Filter) rules cheaply (path + size) before asking
/// the session to materialize the actual [`Content`].
/// A plugin that inspects a piece of content and records information.
///
/// Analyzers are the "read-only" half of the framework: they observe
/// content and write results into the [`Context`]. Use
/// [`Context::local`] for per-object maps,
/// [`Context::global`] for scan-wide aggregates, and
/// [`Context::add_finding`] for a flat list of
/// [`Finding`](crate::Finding)s retrieved after the scan via
/// [`ScanResult::findings`](crate::ScanResult::findings). To run
/// extractors registered for a *different* type on a region of this
/// object (for example the byte offset of an embedded ZIP), call
/// [`Context::request_extract`]. Analyzers do not produce child
/// content themselves — for that, use a [`ContentExtractor`].
///
/// The `M` type parameter is the [`FindingMetadata`](crate::FindingMetadata)
/// attached to each finding. It defaults to
/// [`NoMetadata`](crate::NoMetadata); use
/// [`ScannerBuilder::with_metadata`](crate::ScannerBuilder::with_metadata)
/// when analyzers need a custom metadata type.
///
/// Analyzers can be registered per [`ContentType`] via
/// [`ScannerBuilder::add_analyzer`](crate::ScannerBuilder::add_analyzer)
/// or as generic (all types) plugins via
/// [`ScannerBuilder::add_generic_analyzer`](crate::ScannerBuilder::add_generic_analyzer).
///
/// Every analyzer must implement [`Dependencies`] — typically with
/// `#[derive(Dependencies)]` and a `#[Dependencies(name = "...")]`
/// attribute. In debug builds,
/// [`ScannerBuilder::build`](crate::ScannerBuilder::build) uses that
/// name (and any `requires`) to check that required analyzers are
/// registered with a strictly lower priority.
/// A plugin that turns a container into a stream of child [`Content`]
/// items.
///
/// Extractors are the "produce children" half of the framework. The
/// scanner calls [`create_session`](Self::create_session) once per
/// parent; the returned [`ExtractionSession`] then enumerates children
/// with [`advance`](ExtractionSession::advance) /
/// [`extract`](ExtractionSession::extract). Methods return [`Option`]
/// (or nothing, when the session is dropped) — they do **not** return
/// [`AnalysisOutcome<T>`] and cannot Skip or Exit on their own.
///
/// An extractor registered for type `T` runs in two situations:
///
/// - The current object was **identified as `T`**. The
/// [`ExtractionContext`] then covers the whole object
/// (`offset = 0`, `length = Some(content.size())`, `params = None`).
/// - An analyzer **requested** extraction of `T` from the current
/// object via [`Context::request_extract`]. The context then carries
/// the requested offset, length, and params. The parent does not
/// need to have been identified as `T`.
///
/// One extractor instance is shared by every object of its type, and
/// `create_session` can be re-entered while a previous session is
/// still live (nested containers). Keep configuration on the extractor
/// and put cursors, open archives, and the current [`Entry`] on the
/// session.
///
/// Register extractors via
/// [`ScannerBuilder::add_extractor`](crate::ScannerBuilder::add_extractor).
/// Multiple extractors for the same type run in registration order.
/// A live extraction of children from one parent [`Content`].
///
/// Produced by [`ContentExtractor::create_session`] and driven by the
/// scanner as a short loop:
///
/// 1. [`advance`](Self::advance) — move to the next child and return
/// a lightweight [`Entry`] (path / size / filter skip). `None`
/// ends the stream and the session is dropped.
/// 2. [`extract`](Self::extract) — materialize that child as a boxed
/// [`Content`]. The scanner then recursively scans it (subject to
/// `max_depth`). `None` skips just this entry; enumeration
/// continues with the next `advance`.
///
/// A child's [`AnalysisOutcome::Skip`] does not end this session — the
/// scanner continues with the next `advance`. A child's
/// [`AnalysisOutcome::Exit`] drops the session immediately as the scan
/// unwinds.
///
/// Keep one [`Entry`] as a field and overwrite `entry.path` in place
/// with [`ContentPath::set_from_str`](crate::ContentPath::set_from_str)
/// (synthetic names) or
/// [`ContentPath::set_from_os`](crate::ContentPath::set_from_os)
/// (real OS paths) so `advance` does not allocate a new path for
/// every child.
/// Fast, declarative way to identify a content type without running
/// custom code.
///
/// A [`ContentIdentifier`] can return one of these variants from
/// [`identify_method`](ContentIdentifier::identify_method) so the
/// scanner can build efficient matchers (tries, magic tables, etc.)
/// once and reuse them for every scanned object.
///
/// If none of the variants fit your identifier, return `None` from
/// `identify_method` and perform your own check inside
/// [`validate`](ContentIdentifier::validate).
///
/// Magic patterns ([`Magic`](Self::Magic),
/// [`MultipleMagic`](Self::MultipleMagic)) must be at most 16 bytes.
/// The scanner only feeds the matcher the first 16 bytes of content,
/// and only when at least one identifier registered such a pattern;
/// [`ScannerBuilder::build`](crate::ScannerBuilder::build) panics if a
/// registered magic is longer. To match bytes past that window, return
/// `None` from `identify_method` and call [`Content::read`] in
/// `validate`.
/// A plugin that classifies content into a [`ContentType`].
///
/// Identifiers pair a fast pre-filter ([`IdentifyMethod`]) with an
/// optional custom [`validate`](Self::validate) step. The scanner
/// first uses the pre-filter to narrow down candidate types and then
/// calls `validate` to accept or reject each candidate. Identifiers
/// that return `None` from [`identify_method`](Self::identify_method)
/// are tried afterwards, in registration order, via `validate` alone.
///
/// Register identifiers via
/// [`ScannerBuilder::add_identifier`](crate::ScannerBuilder::add_identifier).
/// Only one identifier is allowed per [`ContentType`].
/// [`ScannerBuilder::build`](crate::ScannerBuilder::build) panics if a
/// [`IdentifyMethod::Magic`] / [`IdentifyMethod::MultipleMagic`]
/// pattern is longer than 16 bytes.
/// Debug-only name and required-analyzer list for a plugin.
///
/// [`ContentAnalyzer`] requires this trait. The usual implementation
/// is `#[derive(Dependencies)]` with a helper attribute:
///
/// ```ignore
/// use content_scan::Dependencies;
///
/// #[derive(Dependencies)]
/// #[Dependencies(name = "NeedsHash", requires = "ComputeHash")]
/// struct NeedsHash;
/// ```
///
/// - `name` is required and must be a non-empty string. It is the
/// identifier other analyzers use in `requires`.
/// - `requires` is optional. It may be a single string or an array of
/// strings naming other analyzers that must run first.
///
/// `name()` and `dependencies()` exist only when `debug_assertions`
/// are enabled. In debug builds,
/// [`ScannerBuilder::build`](crate::ScannerBuilder::build) verifies
/// that every required name is a registered analyzer and that each
/// dependency has a **strictly smaller** `priority`. The check is
/// global: typed and generic analyzers share one name space,
/// regardless of [`ContentType`].
/// Callbacks for watching a scan as it runs.
///
/// Attach an observer with
/// [`ScannerBuilder::observer`](crate::ScannerBuilder::observer).
/// Every method has an empty default, so an implementation only
/// needs to override the events it cares about. The observer is
/// owned by the [`Scanner`](crate::Scanner) and persists across
/// [`scan`](crate::Scanner::scan) calls.
///
/// Paths are the printable form from
/// [`ContentPath::as_printable_string`](crate::ContentPath::as_printable_string).
/// Callbacks are invoked synchronously on the scan thread; keep
/// them cheap, or copy what you need out.
///
/// The `M` type parameter is the
/// [`FindingMetadata`](crate::FindingMetadata) passed to
/// [`on_finding`](Self::on_finding). It matches the scanner's
/// metadata type ([`NoMetadata`](crate::NoMetadata) by default).
/// Predicate that can abort a scan early.
///
/// Attach one with
/// [`ScannerBuilder::stop_condition`](crate::ScannerBuilder::stop_condition).
/// [`should_stop`](Self::should_stop) is checked at the start of
/// every content object, before identification and analysis. When
/// it returns `true`, the scanner unwinds with
/// [`AnalysisOutcome::Exit`] and
/// [`Scanner::scan`](crate::Scanner::scan) returns the
/// [`ScanResult`](crate::ScanResult) accumulated so far.
///
/// The default implementation never stops. Typical uses are a
/// timeout, a finding-count cap, or an external cancellation flag.