@effect-vfs/core 0.5.0 → 0.7.0

package/dist/Caller.d.ts

@@ -0,0 +1,391 @@
+import * as Schema from "effect/Schema";
+import type { ObjectReference } from "./VirtualFileSystem.js";
+/**
+ * Brand key that marks a caller.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export declare const CallerId: unique symbol;
+/**
+ * Brand key that marks a caller.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export type CallerId = typeof CallerId;
+/**
+ * Brand key that marks an object reference.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export declare const ObjectReferenceId: unique symbol;
+/**
+ * Brand key that marks an object reference.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export type ObjectReferenceId = typeof ObjectReferenceId;
+/**
+ * Schema for a caller's credentials. `privileged` is explicit; uid zero alone
+ * grants nothing.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const Identity: Schema.Struct<{
+    readonly uid: Schema.Natural;
+    readonly gid: Schema.Natural;
+    readonly groups: Schema.$Array<Schema.Natural>;
+    readonly privileged: Schema.Boolean;
+}>;
+/**
+ * A caller's credentials.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type Identity = typeof Identity.Type;
+/**
+ * Schema for the options of a root caller.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const RootCallerOptions: Schema.Struct<{
+    readonly identity: Schema.optionalKey<Schema.Struct<{
+        readonly uid: Schema.Natural;
+        readonly gid: Schema.Natural;
+        readonly groups: Schema.$Array<Schema.Natural>;
+        readonly privileged: Schema.Boolean;
+    }>>;
+    readonly umask: Schema.optionalKey<Schema.Natural>;
+}>;
+/**
+ * Options of a root caller.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type RootCallerOptions = typeof RootCallerOptions.Type;
+/**
+ * Schema for the options of `open` on a target: the access mode, whether a
+ * missing file is created, the creation mode, and append and truncate flags.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const OpenOptions: Schema.Struct<{
+    readonly access: Schema.Literals<readonly ["read", "write", "readWrite"]>;
+    readonly create: Schema.optionalKey<Schema.Literals<readonly ["never", "ifMissing", "exclusive"]>>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly append: Schema.optionalKey<Schema.Boolean>;
+    readonly truncate: Schema.optionalKey<Schema.Boolean>;
+}>;
+/**
+ * Options of `open` on a target.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type OpenOptions = typeof OpenOptions.Type;
+/**
+ * Schema for the options of `writeFile`: the open options plus whether a
+ * final symbolic link is replaced or followed and the mode the file ends with.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const WriteFileOptions: Schema.Struct<{
+    readonly access: Schema.Literals<readonly ["read", "write", "readWrite"]>;
+    readonly create: Schema.optionalKey<Schema.Literals<readonly ["never", "ifMissing", "exclusive"]>>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly append: Schema.optionalKey<Schema.Boolean>;
+    readonly truncate: Schema.optionalKey<Schema.Boolean>;
+    readonly followFinalSymlink: Schema.optionalKey<Schema.Boolean>;
+    readonly replaceFinalSymlink: Schema.optionalKey<Schema.Boolean>;
+    readonly finalMode: Schema.optionalKey<Schema.Natural>;
+}>;
+/**
+ * Options of `writeFile`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type WriteFileOptions = typeof WriteFileOptions.Type;
+/**
+ * Schema for a directory's revision before and after a change.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const DirectoryChange: Schema.Struct<{
+    readonly before: Schema.BigInt;
+    readonly after: Schema.BigInt;
+}>;
+/**
+ * A directory's revision before and after a change.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type DirectoryChange = typeof DirectoryChange.Type;
+/**
+ * Schema for the result of `rename`.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const RenameReferenceResult: Schema.TaggedUnion<{
+    readonly DifferentDirectories: Schema.TaggedStruct<"DifferentDirectories", {
+        readonly sourceDirectory: Schema.Struct<{
+            readonly before: Schema.BigInt;
+            readonly after: Schema.BigInt;
+        }>;
+        readonly destinationDirectory: Schema.Struct<{
+            readonly before: Schema.BigInt;
+            readonly after: Schema.BigInt;
+        }>;
+    }>;
+    readonly SameDirectory: Schema.TaggedStruct<"SameDirectory", {
+        readonly directory: Schema.Struct<{
+            readonly before: Schema.BigInt;
+            readonly after: Schema.BigInt;
+        }>;
+    }>;
+}>;
+/**
+ * The result of `rename`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type RenameReferenceResult = typeof RenameReferenceResult.Type;
+/**
+ * Schema for the options of `mkdir`. `exactMode` skips the caller's umask for
+ * an explicit creation mode; permission policy still applies. `recursive`
+ * creates every missing directory on the path in one change, as `mkdir -p`
+ * does, and succeeds when the final directory already exists; the mode
+ * applies to every directory it creates and the times to the final one.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const MkdirOptions: Schema.Struct<{
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly exactMode: Schema.optionalKey<Schema.Boolean>;
+    readonly times: Schema.optionalKey<Schema.Struct<{
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+        readonly modification: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+    }>>;
+    readonly recursive: Schema.optionalKey<Schema.Boolean>;
+}>;
+/**
+ * Options of `mkdir`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type MkdirOptions = typeof MkdirOptions.Type;
+/**
+ * Schema for the options of `walk`: the order entries arrive in and the
+ * optional bounds on how deep, how many, and how many bytes the walk may
+ * reach. `order` defaults to `"pre"`, each directory before its entries; a
+ * `"post"` walk reports each directory after them. Every bound defaults to
+ * unbounded, and a walk that would pass one fails with `LimitExceeded` naming
+ * the bound in `field`.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const WalkOptions: Schema.Struct<{
+    readonly order: Schema.optionalKey<Schema.Literals<readonly ["pre", "post"]>>;
+    readonly maxDepth: Schema.optionalKey<Schema.Natural>;
+    readonly maxEntries: Schema.optionalKey<Schema.Natural>;
+    readonly maxBytes: Schema.optionalKey<Schema.ByteSize>;
+}>;
+/**
+ * Options of `walk`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type WalkOptions = typeof WalkOptions.Type;
+/**
+ * Schema for the options of `remove`. `recursive` removes a directory and
+ * everything under it; `force` succeeds when the target itself is missing.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const RemoveOptions: Schema.Struct<{
+    readonly recursive: Schema.optionalKey<Schema.Boolean>;
+    readonly force: Schema.optionalKey<Schema.Boolean>;
+}>;
+/**
+ * Options of `remove`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type RemoveOptions = typeof RemoveOptions.Type;
+/**
+ * Schema for the options of `symlink`.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const SymlinkOptions: Schema.Struct<{
+    readonly times: Schema.optionalKey<Schema.Struct<{
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+        readonly modification: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+    }>>;
+}>;
+/**
+ * Options of `symlink`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type SymlinkOptions = typeof SymlinkOptions.Type;
+/**
+ * Schema for the attributes `setattr` changes together: a regular file's
+ * size, the permission mode, the owner, and the access and modification
+ * times. An omitted attribute keeps its current value. `expected` pins the
+ * target's revision the caller last observed, checked inside the same change,
+ * and fails as `StaleReference` naming `expected` when the target has moved
+ * on, so a change decided from that observation never applies to a newer one.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const SetattrOptions: Schema.Struct<{
+    readonly size: Schema.optionalKey<Schema.BigInt>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly owner: Schema.optionalKey<Schema.Struct<{
+        readonly uid: Schema.optionalKey<Schema.Natural>;
+        readonly gid: Schema.optionalKey<Schema.Natural>;
+    }>>;
+    readonly times: Schema.optionalKey<Schema.Struct<{
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+        readonly modification: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+    }>>;
+    readonly expected: Schema.optionalKey<Schema.Struct<{
+        readonly revision: Schema.BigInt;
+    }>>;
+}>;
+/**
+ * Attributes of `setattr`.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type SetattrOptions = typeof SetattrOptions.Type;
+/**
+ * Schema for an object reference: any value carrying the reference brand. Whether the volume issued it is checked
+ * where it is used.
+ *
+ * @internal
+ */
+export declare const ObjectReferenceSchema: Schema.declare<ObjectReference, ObjectReference>;
+/**
+ * Schema for the options of `open` on an entry, a lookup-or-create-and-open in
+ * one gate hold. `expected` pins the child the caller last observed under the
+ * name (or `null` for none) and fails as `VolumeBusy` when another has
+ * appeared; `expectedChild` pins its revision and times as well and fails as
+ * `StaleReference` when they moved.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const OpenEntryOptions: Schema.Struct<{
+    readonly access: Schema.Literals<readonly ["read", "write", "readWrite"]>;
+    readonly create: Schema.optionalKey<Schema.Literals<readonly ["never", "ifMissing", "exclusive"]>>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly append: Schema.optionalKey<Schema.Boolean>;
+    readonly truncate: Schema.optionalKey<Schema.Boolean>;
+    readonly followFinalSymlink: Schema.optionalKey<Schema.Boolean>;
+    readonly times: Schema.optionalKey<Schema.Struct<{
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+        readonly modification: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"now">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"omit">;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"value">;
+            readonly nanoseconds: Schema.BigInt;
+        }>]>;
+    }>>;
+    readonly initialSize: Schema.optionalKey<Schema.BigInt>;
+    readonly exactMode: Schema.optionalKey<Schema.Boolean>;
+    readonly owner: Schema.optionalKey<Schema.Struct<{
+        readonly uid: Schema.optionalKey<Schema.Natural>;
+        readonly gid: Schema.optionalKey<Schema.Natural>;
+    }>>;
+    readonly expected: Schema.optionalKey<Schema.NullOr<Schema.declare<ObjectReference, ObjectReference>>>;
+    readonly expectedChild: Schema.optionalKey<Schema.NullOr<Schema.Struct<{
+        readonly reference: Schema.declare<ObjectReference, ObjectReference>;
+        readonly revision: Schema.BigInt;
+        readonly atimeNs: Schema.BigInt;
+        readonly mtimeNs: Schema.BigInt;
+    }>>>;
+}>;
+/**
+ * Options of `open` on an entry.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type OpenEntryOptions = typeof OpenEntryOptions.Type;
+//# sourceMappingURL=Caller.d.ts.map

package/dist/Caller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Caller.d.ts","sourceRoot":"","sources":["../src/Caller.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAE7D;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,MAA8C,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAA;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAO,MAAuD,CAAA;AAE9F;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAExD;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ;;;;;EAKnB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;EAG5B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAA;AAE7D;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;;;;EAMtB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;EAK3B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;EAG1B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;EAMhC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAC,IAAI,CAAA;AAErE;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;EAKvB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,CAAA;AAEnD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW;;;;;EAKtB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;EAGxB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAErD;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;EAEzB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMzB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,kDAEjC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAc3B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAA"}

package/dist/Caller.js

@@ -0,0 +1,199 @@
+/**
+ * Caller identity brands and schemas: credentials, root caller options, and
+ * the settings and results of the operations a caller performs.
+ *
+ * @since 0.6.0
+ */
+import * as Predicate from "effect/Predicate";
+import * as Schema from "effect/Schema";
+import { Mode, OwnerUpdate, Times, Timestamp } from "./Metadata.js";
+/**
+ * Brand key that marks a caller.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export const CallerId = Symbol.for("@effect-vfs/core/Caller");
+/**
+ * Brand key that marks an object reference.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export const ObjectReferenceId = Symbol.for("@effect-vfs/core/ObjectReference");
+/**
+ * Schema for a caller's credentials. `privileged` is explicit; uid zero alone
+ * grants nothing.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const Identity = Schema.Struct({
+    uid: Schema.Natural,
+    gid: Schema.Natural,
+    groups: Schema.Array(Schema.Natural),
+    privileged: Schema.Boolean
+});
+/**
+ * Schema for the options of a root caller.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const RootCallerOptions = Schema.Struct({
+    identity: Schema.optionalKey(Identity),
+    umask: Schema.optionalKey(Schema.Natural.check(Schema.isLessThanOrEqualTo(0o777)))
+});
+/**
+ * Schema for the options of `open` on a target: the access mode, whether a
+ * missing file is created, the creation mode, and append and truncate flags.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const OpenOptions = Schema.Struct({
+    access: Schema.Literals(["read", "write", "readWrite"]),
+    create: Schema.optionalKey(Schema.Literals(["never", "ifMissing", "exclusive"])),
+    mode: Schema.optionalKey(Mode),
+    append: Schema.optionalKey(Schema.Boolean),
+    truncate: Schema.optionalKey(Schema.Boolean)
+});
+/**
+ * Schema for the options of `writeFile`: the open options plus whether a
+ * final symbolic link is replaced or followed and the mode the file ends with.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const WriteFileOptions = Schema.Struct({
+    ...OpenOptions.fields,
+    followFinalSymlink: Schema.optionalKey(Schema.Boolean),
+    replaceFinalSymlink: Schema.optionalKey(Schema.Boolean),
+    finalMode: Schema.optionalKey(Mode)
+});
+/**
+ * Schema for a directory's revision before and after a change.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const DirectoryChange = Schema.Struct({
+    before: Schema.BigInt,
+    after: Schema.BigInt
+});
+/**
+ * Schema for the result of `rename`.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const RenameReferenceResult = Schema.TaggedUnion({
+    SameDirectory: { directory: DirectoryChange },
+    DifferentDirectories: {
+        sourceDirectory: DirectoryChange,
+        destinationDirectory: DirectoryChange
+    }
+});
+/**
+ * Schema for the options of `mkdir`. `exactMode` skips the caller's umask for
+ * an explicit creation mode; permission policy still applies. `recursive`
+ * creates every missing directory on the path in one change, as `mkdir -p`
+ * does, and succeeds when the final directory already exists; the mode
+ * applies to every directory it creates and the times to the final one.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const MkdirOptions = Schema.Struct({
+    mode: Schema.optionalKey(Mode),
+    exactMode: Schema.optionalKey(Schema.Boolean),
+    times: Schema.optionalKey(Times),
+    recursive: Schema.optionalKey(Schema.Boolean)
+});
+/**
+ * Schema for the options of `walk`: the order entries arrive in and the
+ * optional bounds on how deep, how many, and how many bytes the walk may
+ * reach. `order` defaults to `"pre"`, each directory before its entries; a
+ * `"post"` walk reports each directory after them. Every bound defaults to
+ * unbounded, and a walk that would pass one fails with `LimitExceeded` naming
+ * the bound in `field`.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const WalkOptions = Schema.Struct({
+    order: Schema.optionalKey(Schema.Literals(["pre", "post"])),
+    maxDepth: Schema.optionalKey(Schema.Natural),
+    maxEntries: Schema.optionalKey(Schema.Natural),
+    maxBytes: Schema.optionalKey(Schema.ByteSize)
+});
+/**
+ * Schema for the options of `remove`. `recursive` removes a directory and
+ * everything under it; `force` succeeds when the target itself is missing.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const RemoveOptions = Schema.Struct({
+    recursive: Schema.optionalKey(Schema.Boolean),
+    force: Schema.optionalKey(Schema.Boolean)
+});
+/**
+ * Schema for the options of `symlink`.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const SymlinkOptions = Schema.Struct({
+    times: Schema.optionalKey(Times)
+});
+/**
+ * Schema for the attributes `setattr` changes together: a regular file's
+ * size, the permission mode, the owner, and the access and modification
+ * times. An omitted attribute keeps its current value. `expected` pins the
+ * target's revision the caller last observed, checked inside the same change,
+ * and fails as `StaleReference` naming `expected` when the target has moved
+ * on, so a change decided from that observation never applies to a newer one.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const SetattrOptions = Schema.Struct({
+    size: Schema.optionalKey(Schema.BigInt.check(Schema.isGreaterThanOrEqualToBigInt(0n))),
+    mode: Schema.optionalKey(Mode),
+    owner: Schema.optionalKey(OwnerUpdate),
+    times: Schema.optionalKey(Times),
+    expected: Schema.optionalKey(Schema.Struct({ revision: Schema.BigInt }))
+});
+/**
+ * Schema for an object reference: any value carrying the reference brand. Whether the volume issued it is checked
+ * where it is used.
+ *
+ * @internal
+ */
+export const ObjectReferenceSchema = Schema.declare((input) => Predicate.hasProperty(ObjectReferenceId)(input) && input[ObjectReferenceId] === true);
+/**
+ * Schema for the options of `open` on an entry, a lookup-or-create-and-open in
+ * one gate hold. `expected` pins the child the caller last observed under the
+ * name (or `null` for none) and fails as `VolumeBusy` when another has
+ * appeared; `expectedChild` pins its revision and times as well and fails as
+ * `StaleReference` when they moved.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const OpenEntryOptions = Schema.Struct({
+    ...OpenOptions.fields,
+    followFinalSymlink: Schema.optionalKey(Schema.Boolean),
+    times: Schema.optionalKey(Times),
+    initialSize: Schema.optionalKey(Schema.BigInt),
+    exactMode: Schema.optionalKey(Schema.Boolean),
+    owner: Schema.optionalKey(OwnerUpdate),
+    expected: Schema.optionalKey(Schema.NullOr(ObjectReferenceSchema)),
+    expectedChild: Schema.optionalKey(Schema.NullOr(Schema.Struct({
+        reference: ObjectReferenceSchema,
+        revision: Schema.BigInt,
+        atimeNs: Timestamp,
+        mtimeNs: Timestamp
+    })))
+});

package/dist/FileHandle.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Identity brands and schemas for open file and directory handles.
+ *
+ * @since 0.6.0
+ */
+import * as Schema from "effect/Schema";
+/**
+ * Brand key that marks an open file handle.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export declare const FileHandleId: unique symbol;
+/**
+ * Brand key that marks an open file handle.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export type FileHandleId = typeof FileHandleId;
+/**
+ * Brand key that marks an open directory handle.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export declare const DirectoryHandleId: unique symbol;
+/**
+ * Brand key that marks an open directory handle.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export type DirectoryHandleId = typeof DirectoryHandleId;
+/**
+ * Schema for the origin of a seek: the file start, the current position, the
+ * end, or the next data or hole region.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export declare const SeekMode: Schema.Literals<readonly ["start", "current", "end", "data", "hole"]>;
+/**
+ * The origin of a seek.
+ *
+ * @category models
+ * @since 0.6.0
+ */
+export type SeekMode = typeof SeekMode.Type;
+//# sourceMappingURL=FileHandle.d.ts.map

package/dist/FileHandle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileHandle.d.ts","sourceRoot":"","sources":["../src/FileHandle.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,OAAO,MAAkD,CAAA;AAEpF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAA;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAO,MAAuD,CAAA;AAE9F;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAExD;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,uEAA+D,CAAA;AAEpF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA"}

package/dist/FileHandle.js

@@ -0,0 +1,28 @@
+/**
+ * Identity brands and schemas for open file and directory handles.
+ *
+ * @since 0.6.0
+ */
+import * as Schema from "effect/Schema";
+/**
+ * Brand key that marks an open file handle.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export const FileHandleId = Symbol.for("@effect-vfs/core/FileHandle");
+/**
+ * Brand key that marks an open directory handle.
+ *
+ * @category type IDs
+ * @since 0.6.0
+ */
+export const DirectoryHandleId = Symbol.for("@effect-vfs/core/DirectoryHandle");
+/**
+ * Schema for the origin of a seek: the file start, the current position, the
+ * end, or the next data or hole region.
+ *
+ * @category schemas
+ * @since 0.6.0
+ */
+export const SeekMode = Schema.Literals(["start", "current", "end", "data", "hole"]);