@effect-vfs/core 0.7.1 → 0.9.0

package/dist/Search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Search.d.ts","sourceRoot":"","sources":["../src/Search.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAKxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,IAAI,4DAAoD,CAAA;AAErE;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,CAAA;AAoBnC;;;;;GAKG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;EAA6B,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC,IAAI,CAAA;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;EAgBzB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,KAAK,4RAgBhB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC,IAAI,CAAA;AAErC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,EAAE,MAgB1B,CAAA;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;EAMpB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;EAMf,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,CAAA;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,KAAK;;;;;;EAMhB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC,IAAI,CAAA;AAErC;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU;;;IAGrB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;EAMrB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;;AAE/C;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,iBAKhC;CAAG;;;;;AAEL;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,mBAGlC;CAAG;AAEL;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,YAAY,CAAA;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,cAAc,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,OAAO;;;;;;;EAelB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAA;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOvB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,CAAA;AAEnD;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;;;EAAgE,CAAA;AAEvF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO;;;;EAA2F,CAAA;AAE/G;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAA;AAEzC;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;EAKrB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAE/C;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;EAGtB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;EAM3B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAA;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,SAAS,GAAG,YAAY,CAAA;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,cAAc,CAAA;AA4ChE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,QAAQ,aAAc,QAAQ,SAAS,SAAS,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAWlG,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,CAwBjG,CAAA;AA+CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,SAAS,aAAc,QAAQ,SAAS,YAAY,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,kBAAkB,CACzE,CAAA;AAEvC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,cAAc,CAGtG,CAAA;AAEJ;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,aAAc,QAAQ,SAAS,YAAY,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CACrE,CAAA;AAEvC;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,cAAc,CAGtG,CAAA;AAEJ;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,aACf,QAAQ,SACX,YAAY,KAClB,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,kBAAkB,CAA+C,CAAA;AAE/F;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,CACvB,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,YAAY,KAChB,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,cAAc,CAIlD,CAAA"}

package/dist/Search.js

@@ -0,0 +1,576 @@
+/**
+ * Bounded filename and content search over an explicit immutable snapshot.
+ *
+ * Search grants the snapshot's authority, without caller permission filtering.
+ * Paths are exact UTF-8 strings relative to the selected directory root. Hidden
+ * names are included, discovered symlinks are not followed, and hard-link names
+ * are searched independently. Glob never reads or copies file contents.
+ *
+ * @since 0.8.0
+ */
+import * as ByteSize from "effect/ByteSize";
+import * as Effect from "effect/Effect";
+import * as Schema from "effect/Schema";
+import * as Stream from "effect/Stream";
+import { BytePath } from "./BytePath.js";
+import * as Glob from "./internal/glob.js";
+import * as Visitor from "./internal/search.js";
+import * as Content from "./internal/searchContent.js";
+import * as Internal from "./internal/searchModel.js";
+/**
+ * Entry kinds selected by filename queries.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Kind = Schema.Literals(["file", "directory", "symlink"]);
+const limitFields = {
+    maxEntries: Schema.Natural,
+    maxDepth: Schema.Natural,
+    maxPathBytes: Schema.ByteSize,
+    maxResults: Schema.Natural,
+    maxResultBytes: Schema.ByteSize,
+    maxPatternBytes: Schema.ByteSize,
+    maxPatterns: Schema.Natural,
+    maxPatternListBytes: Schema.ByteSize,
+    maxExpansions: Schema.Natural,
+    maxTokens: Schema.Natural,
+    maxMatchingWork: Schema.Natural,
+    maxScannedBytes: Schema.ByteSize,
+    maxFileBytes: Schema.ByteSize,
+    maxLineEvaluations: Schema.Natural,
+    maxExcerptBytes: Schema.ByteSize
+};
+/**
+ * Complete finite namespace, matching, content and output limits.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Limits = Schema.Struct(limitFields);
+/**
+ * Optional overrides applied to default limits.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const LimitOverrides = Schema.Struct({
+    maxEntries: Schema.optionalKey(limitFields.maxEntries),
+    maxDepth: Schema.optionalKey(limitFields.maxDepth),
+    maxPathBytes: Schema.optionalKey(limitFields.maxPathBytes),
+    maxResults: Schema.optionalKey(limitFields.maxResults),
+    maxResultBytes: Schema.optionalKey(limitFields.maxResultBytes),
+    maxPatternBytes: Schema.optionalKey(limitFields.maxPatternBytes),
+    maxPatterns: Schema.optionalKey(limitFields.maxPatterns),
+    maxPatternListBytes: Schema.optionalKey(limitFields.maxPatternListBytes),
+    maxExpansions: Schema.optionalKey(limitFields.maxExpansions),
+    maxTokens: Schema.optionalKey(limitFields.maxTokens),
+    maxMatchingWork: Schema.optionalKey(limitFields.maxMatchingWork),
+    maxScannedBytes: Schema.optionalKey(limitFields.maxScannedBytes),
+    maxFileBytes: Schema.optionalKey(limitFields.maxFileBytes),
+    maxLineEvaluations: Schema.optionalKey(limitFields.maxLineEvaluations),
+    maxExcerptBytes: Schema.optionalKey(limitFields.maxExcerptBytes)
+});
+/**
+ * Names of compiler, traversal, output and content bounds.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Limit = Schema.Literals([
+    "maxEntries",
+    "maxDepth",
+    "maxPathBytes",
+    "maxResults",
+    "maxResultBytes",
+    "maxPatternBytes",
+    "maxPatterns",
+    "maxPatternListBytes",
+    "maxExpansions",
+    "maxTokens",
+    "maxMatchingWork",
+    "maxScannedBytes",
+    "maxFileBytes",
+    "maxLineEvaluations",
+    "maxExcerptBytes"
+]);
+/**
+ * Finite default work policy. Byte limits use exact `ByteSize` values.
+ *
+ * Defaults are 100,000 entries, depth 256, 4 KiB paths, 100 rows, 64 KiB
+ * result payload, 4 KiB per pattern, 128 pattern sources, 64 KiB aggregate
+ * sources, 1,024 expanded alternatives, 65,536 compiled tokens, and 10 million
+ * matching operations. Content defaults are 64 MiB scanned bytes, 1 MiB per
+ * file, 100,000 line evaluations and 1 KiB excerpts. Glob performs no content work. These bounds do not promise a deadline or
+ * measure JavaScript heap or serialized JSON size.
+ *
+ * @category defaults
+ * @since 0.8.0
+ */
+export const defaultLimits = Object.freeze({
+    maxEntries: 100_000,
+    maxDepth: 256,
+    maxPathBytes: ByteSize.bytes(4_096),
+    maxResults: 100,
+    maxResultBytes: ByteSize.bytes(65_536),
+    maxPatternBytes: ByteSize.bytes(4_096),
+    maxPatterns: 128,
+    maxPatternListBytes: ByteSize.bytes(65_536),
+    maxExpansions: 1_024,
+    maxTokens: 65_536,
+    maxMatchingWork: 10_000_000,
+    maxScannedBytes: ByteSize.bytes(67_108_864),
+    maxFileBytes: ByteSize.bytes(1_048_576),
+    maxLineEvaluations: 100_000,
+    maxExcerptBytes: ByteSize.bytes(1_024)
+});
+/**
+ * An explicit directory root, nonempty include list and optional exclusions,
+ * kinds and limits. All patterns are root-relative and case-sensitive.
+ *
+ * Wildcards and classes match Unicode code points without normalization.
+ * Supports `*`, `?`, classes, comma brace alternatives, whole-segment `**`,
+ * backslash escapes, and a directory-only trailing slash. Excluded directories
+ * prune traversal. Include selectors and kind filters do not prune directories.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const GlobQuery = Schema.Struct({
+    root: Schema.Union([Schema.String, BytePath]),
+    include: Schema.NonEmptyArray(Schema.String),
+    exclude: Schema.optionalKey(Schema.Array(Schema.String)),
+    kinds: Schema.optionalKey(Schema.Array(Kind)),
+    limits: Schema.optionalKey(LimitOverrides)
+});
+/**
+ * Work counts, with exact raw UTF-8 result bytes.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Work = Schema.Struct({
+    entries: Schema.Natural,
+    matchingWork: Schema.Natural,
+    resultBytes: Schema.ByteSize,
+    scannedBytes: Schema.ByteSize,
+    lineEvaluations: Schema.Natural
+});
+/**
+ * Counted policy skips. Descendants of skipped directories are not estimated.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Skips = Schema.Struct({
+    invalidNames: Schema.Natural,
+    invalidNameSubtrees: Schema.Natural,
+    oversizedFiles: Schema.Natural,
+    invalidUtf8Files: Schema.Natural,
+    binaryFiles: Schema.Natural
+});
+/**
+ * `Complete` exhausts the eligible namespace, possibly with skips. `Stopped`
+ * names the exhausted bound and a root-relative path when representable.
+ * The empty string identifies the selected root. Stopping does not assert
+ * that another matching entry exists.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Completion = Schema.Union([
+    Schema.TaggedStruct("Complete", {}),
+    Schema.TaggedStruct("Stopped", { limit: Limit, path: Schema.optionalKey(Schema.String) })
+]);
+/**
+ * A selected root, preceding results, counters and completion.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const GlobReport = Schema.Struct({
+    root: GlobQuery.fields.root,
+    results: Schema.Array(Schema.String),
+    work: Work,
+    skips: Skips,
+    completion: Completion
+});
+/**
+ * Invalid query, pattern syntax or aggregate compilation limit.
+ *
+ * @category errors
+ * @since 0.8.0
+ */
+export class QueryFailure extends Schema.TaggedError()("SearchQueryFailure", {
+    field: Schema.String,
+    message: Schema.String,
+    pattern: Schema.optionalKey(Schema.String),
+    limit: Schema.optionalKey(Limit)
+}) {
+}
+/**
+ * Typed runtime budget exhaustion.
+ *
+ * @category errors
+ * @since 0.8.0
+ */
+export class BudgetExceeded extends Schema.TaggedError()("SearchBudgetExceeded", {
+    limit: Limit,
+    path: Schema.optionalKey(Schema.String)
+}) {
+}
+/**
+ * Explicit content interpretation. Literal strings never become regex implicitly.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Pattern = Schema.TaggedUnion({
+    Literal: {
+        pattern: Schema.NonEmptyString.check(Schema.makeFilter((value) => !value.includes("\0") && !value.includes("\r") && !value.includes("\n") && !/[\ud800-\udfff]/u.test(value), {
+            expected: "literal line text without NUL, CR, LF or lone surrogates"
+        }))
+    },
+    Regex: {
+        pattern: Schema.String
+    }
+});
+/**
+ * Regular-file content selection using the same case-sensitive filename globs as
+ * `GlobQuery`. Content `ignoreCase` defaults to false and never affects filenames.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const ContentQuery = Schema.Struct({
+    root: GlobQuery.fields.root,
+    include: GlobQuery.fields.include,
+    exclude: GlobQuery.fields.exclude,
+    pattern: Pattern,
+    ignoreCase: Schema.optionalKey(Schema.Boolean),
+    limits: GlobQuery.fields.limits
+});
+/**
+ * Half-open, file-absolute UTF-8 byte offsets. These are safe integers, not UTF-16
+ * indices or character columns.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const MatchRange = Schema.Struct({ start: Schema.Natural, end: Schema.Natural });
+/**
+ * UTF-8-bounded text beginning at the match, with its original file-byte start.
+ * `truncated` is true when any line prefix or suffix is omitted. The full match
+ * range can extend beyond this text. A zero-width end match can have empty text.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const Excerpt = Schema.Struct({ text: Schema.String, start: Schema.Natural, truncated: Schema.Boolean });
+/**
+ * One matching line, its first whole match and bounded excerpt. Line numbers are
+ * 1-based; paths are root-relative. LF separates lines, CR is stripped only before
+ * LF, BOM and lone CR are preserved, and a final LF adds no synthetic empty line.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const LineResult = Schema.Struct({
+    path: Schema.String,
+    lineNumber: Schema.Int.check(Schema.isGreaterThanOrEqualTo(1)),
+    range: MatchRange,
+    excerpt: Excerpt
+});
+/**
+ * Exact matching-line count for one completely scanned matching file. This counts
+ * lines, not occurrences. Incomplete files never produce a count row.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const CountResult = Schema.Struct({
+    path: Schema.String,
+    count: Schema.Int.check(Schema.isGreaterThanOrEqualTo(1))
+});
+/**
+ * Preceding line matches with coverage, work and skips.
+ * `Complete` covers eligible content and can still contain skips. Stopped or skipped
+ * query totals are lower bounds for the original scope.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const LinesReport = Schema.Struct({
+    root: ContentQuery.fields.root,
+    results: Schema.Array(LineResult),
+    work: Work,
+    skips: Skips,
+    completion: Completion
+});
+/**
+ * Preceding matching filenames with coverage, work and skips.
+ * `Complete` covers eligible content and can still contain skips. Stopped or skipped
+ * query totals are lower bounds for the original scope.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const FilesReport = Schema.Struct({
+    root: ContentQuery.fields.root,
+    results: Schema.Array(Schema.String),
+    work: Work,
+    skips: Skips,
+    completion: Completion
+});
+/**
+ * Preceding completed-file counts with coverage, work and skips.
+ * `Complete` covers eligible content and can still contain skips. Stopped or skipped
+ * query totals are lower bounds for the original scope.
+ *
+ * @category schemas
+ * @since 0.8.0
+ */
+export const CountLinesReport = Schema.Struct({
+    root: ContentQuery.fields.root,
+    results: Schema.Array(CountResult),
+    work: Work,
+    skips: Skips,
+    completion: Completion
+});
+const evaluate = Effect.fnUntraced(function* (snapshot, input) {
+    const { query, limits } = yield* Internal.query(input);
+    const patterns = yield* Glob.compile(query, limits);
+    const meter = Internal.makeMeter(limits);
+    const visitor = yield* Visitor.makeVisitor(snapshot, query.root, meter);
+    let rows = 0;
+    let stopped = limits.maxResults === 0
+        ? new BudgetExceeded({ limit: "maxResults", path: "" })
+        : undefined;
+    const select = Effect.fnUntraced(function* (entry) {
+        const match = yield* Glob.matches(patterns, entry.parts, entry.kind, meter);
+        return {
+            selected: !match.excluded && match.included && (query.kinds === undefined || query.kinds.includes(entry.kind)),
+            prune: match.excluded
+        };
+    });
+    const next = Effect.fnUntraced(function* () {
+        if (stopped !== undefined)
+            return yield* stopped;
+        const entry = yield* visitor.next(select);
+        if (entry === undefined)
+            return undefined;
+        const size = BigInt(entry.pathBytes);
+        if (size > limits.maxResultBytes - meter.work.resultBytes) {
+            return yield* new BudgetExceeded({ limit: "maxResultBytes", path: entry.path });
+        }
+        meter.work.resultBytes = ByteSize.bytes(meter.work.resultBytes + size);
+        rows += 1;
+        if (rows === limits.maxResults)
+            stopped = new BudgetExceeded({ limit: "maxResults", path: entry.path });
+        return entry.path;
+    });
+    return { query, meter, next };
+});
+/**
+ * Stream ordinary root-relative strings in depth-first preorder, with each
+ * directory sorted by raw name bytes. Resolve the root through directory
+ * symlinks; never follow discovered symlinks or emit the root itself.
+ *
+ * A budget failure may follow earlier rows. Taking a prefix establishes no
+ * completion. Use `glob` when skip counts or coverage matter. Each evaluation
+ * owns fresh traversal and counters, including repeated or concurrent runs.
+ *
+ * @example
+ * ```ts
+ * import * as BunCrypto from "@effect/platform-bun/BunCrypto"
+ * import { Search, VirtualFileSystem as Vfs } from "@effect-vfs/core"
+ * import { Effect, Stream } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const volume = yield* Vfs.fromFixture({ entries: [
+ *     { kind: "file", path: "/😀.ts", bytes: new Uint8Array() }
+ *   ] })
+ *   const snapshot = yield* volume.snapshot
+ *   return yield* Stream.runCollect(Search.scanGlob(snapshot, { root: "/", include: ["?.ts"] }))
+ * })
+ * Effect.runPromise(program.pipe(Effect.provide(BunCrypto.layer))).then(console.log)
+ * // [ '😀.ts' ]
+ * ```
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const scanGlob = (snapshot, query) => Stream.unwrap(Effect.map(evaluate(snapshot, query), ({ next }) => Stream.unfold(undefined, Effect.fnUntraced(function* () {
+    const row = yield* next();
+    return row === undefined ? undefined : [row, undefined];
+}))));
+/**
+ * Collect bounded matches and preserve preceding rows when a work or output
+ * budget stops the query. Invalid queries, malformed patterns and snapshot
+ * failures remain typed failures; interruption remains interruption.
+ *
+ * Reaching the row cap always reports `Stopped`, even for the last possible
+ * result. Invalid UTF-8 names are counted skips, and invalid-name directories
+ * count one skipped subtree without examining its descendants.
+ *
+ * @example
+ * ```ts
+ * import * as BunCrypto from "@effect/platform-bun/BunCrypto"
+ * import { Search, VirtualFileSystem as Vfs } from "@effect-vfs/core"
+ * import { Effect } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const volume = yield* Vfs.fromFixture({ entries: [
+ *     { kind: "file", path: "/a.ts", bytes: new Uint8Array() },
+ *     { kind: "file", path: "/b.ts", bytes: new Uint8Array() }
+ *   ] })
+ *   return yield* Search.glob(yield* volume.snapshot, {
+ *     root: "/", include: ["*.ts"], limits: { maxResults: 1 }
+ *   })
+ * })
+ * Effect.runPromise(program.pipe(Effect.provide(BunCrypto.layer))).then((report) => {
+ *   console.log(report.results, report.completion._tag)
+ * })
+ * // [ "a.ts" ] Stopped
+ * ```
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const glob = Effect.fnUntraced(function* (snapshot, query) {
+    const evaluation = yield* evaluate(snapshot, query);
+    const results = [];
+    const completion = yield* Effect.gen(function* () {
+        for (let row = yield* evaluation.next(); row !== undefined; row = yield* evaluation.next())
+            results.push(row);
+        return Completion.members[0].make({});
+    }).pipe(Effect.catchTag("SearchBudgetExceeded", (error) => Effect.succeed(error.path === undefined
+        ? Completion.members[1].make({ limit: error.limit })
+        : Completion.members[1].make({ limit: error.limit, path: error.path }))));
+    return {
+        root: evaluation.query.root,
+        results,
+        work: { ...evaluation.meter.work },
+        skips: { ...evaluation.meter.skips },
+        completion
+    };
+});
+const scanContent = (snapshot, query, mode) => Stream.unwrap(Effect.map(Content.evaluate(snapshot, query, mode), ({ next }) => Stream.unfold(undefined, Effect.fnUntraced(function* () {
+    const row = yield* next();
+    return row === undefined ? undefined : [row, undefined];
+}))));
+const collectContent = Effect.fnUntraced(function* (snapshot, query, mode) {
+    const evaluation = yield* Content.evaluate(snapshot, query, mode);
+    const results = [];
+    const completion = yield* Effect.gen(function* () {
+        for (let row = yield* evaluation.next(); row !== undefined; row = yield* evaluation.next())
+            results.push(row);
+        return Completion.members[0].make({});
+    }).pipe(Effect.catchTag("SearchBudgetExceeded", (error) => Effect.succeed(error.path === undefined
+        ? Completion.members[1].make({ limit: error.limit })
+        : Completion.members[1].make({ limit: error.limit, path: error.path }))));
+    return {
+        root: evaluation.query.root,
+        results,
+        work: { ...evaluation.meter.work },
+        skips: { ...evaluation.meter.skips },
+        completion
+    };
+});
+/**
+ * Stream one result per matching line after classifying the complete file for
+ * strict UTF-8 and NUL. Each row contains the first whole-match byte range and
+ * a UTF-8-bounded excerpt beginning at the match. Files and hard-link names are
+ * selected independently; invalid, binary and oversized files are skipped.
+ *
+ * A budget failure can follow earlier rows. A prefix establishes no completion;
+ * use `lines` for coverage and skip counters. Each evaluation owns fresh state.
+ * Native regex can block within one call; Effect timeouts cannot preempt it.
+ *
+ * @example
+ * ```ts
+ * import * as BunCrypto from "@effect/platform-bun/BunCrypto"
+ * import { Search, VirtualFileSystem as Vfs } from "@effect-vfs/core"
+ * import { Effect, Stream } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const volume = yield* Vfs.fromFixture({ entries: [
+ *     { kind: "file", path: "/note", bytes: new TextEncoder().encode("😀TODO\n") }
+ *   ] })
+ *   return yield* Stream.runCollect(Search.scanLines(yield* volume.snapshot, {
+ *     root: "/", include: ["**"], pattern: Search.Pattern.cases.Literal.make({ pattern: "TODO" })
+ *   }))
+ * })
+ * Effect.runPromise(program.pipe(Effect.provide(BunCrypto.layer))).then((rows) => {
+ *   console.log(rows[0]?.range)
+ * })
+ * // { start: 4, end: 8 }
+ * ```
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const scanLines = (snapshot, query) => scanContent(snapshot, query, "lines");
+/**
+ * Collect matching lines, preceding rows, skips, work and completion. Catch only
+ * budget exhaustion; query, pattern and snapshot failures remain typed failures,
+ * and interruption propagates. Reaching the result cap reports `Stopped` with
+ * no lookahead, even for the last possible result.
+ *
+ * Raw row bytes are UTF-8 path and excerpt bytes plus 16 bytes for the range.
+ * Scalar metadata is excluded; this is not heap or serialized JSON accounting.
+ * Complete classification charges full eligible file bytes, including skips and
+ * repeated hard-link scans. Empty files have no lines.
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const lines = Effect
+    .fnUntraced(function* (snapshot, query) {
+    return yield* collectContent(snapshot, query, "lines");
+});
+/**
+ * Stream one root-relative filename per matching regular-file path. Classify
+ * the complete file before testing lines and stop matching after the first hit.
+ * Build no line-result ranges or excerpts. Budget exhaustion fails the Stream;
+ * use `files` for coverage and skip counters.
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const scanFiles = (snapshot, query) => scanContent(snapshot, query, "files");
+/**
+ * Collect matching filenames with preceding rows, work, skips and completion.
+ * Shares text classification and matching with `lines`, but evaluates only as
+ * far as the first hit in each classified file. Raw result bytes count paths
+ * only; scanned bytes still charge the full selected file before classification.
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const files = Effect
+    .fnUntraced(function* (snapshot, query) {
+    return yield* collectContent(snapshot, query, "files");
+});
+/**
+ * Stream exact matching-line counts for completely scanned matching files.
+ * Multiple occurrences on one line count once. A stopped file emits no partial
+ * count; earlier completed rows can precede a budget failure. Builds no line
+ * ranges or excerpts. Use `countLines` when coverage information matters.
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const scanCountLines = (snapshot, query) => scanContent(snapshot, query, "countLines");
+/**
+ * Collect exact per-file matching-line counts with work, skips and completion.
+ * A stopped or skipped query's summed counts are lower bounds for its original
+ * scope. Raw result accounting is UTF-8 path bytes plus 8 bytes per count;
+ * scalar metadata is excluded, as in the other content modes.
+ *
+ * @category operations
+ * @since 0.8.0
+ */
+export const countLines = Effect.fnUntraced(function* (snapshot, query) {
+    return yield* collectContent(snapshot, query, "countLines");
+});