@zenfs/core 2.0.0 → 2.1.0

package/dist/internal/inode.d.ts

@@ -1,3 +1,4 @@
+import { BufferView } from 'utilium/buffer.js';
 import { Stats, type StatsLike } from '../vfs/stats.js';
 import { type V_Context } from './contexts.js';
 /**
@@ -5,32 +6,23 @@ import { type V_Context } from './contexts.js';
  * @hidden
  */
 export declare const rootIno = 0;
-declare class Attribute {
-    protected keySize: number;
-    protected valueSize: number;
-    protected _key: string;
-    get key(): string;
-    set key(value: string);
-    protected _value: Uint8Array;
-    get value(): Uint8Array;
-    set value(value: Uint8Array);
-    constructor(key?: string, value?: Uint8Array);
-}
 /**
  * Extended attributes
  * @category Internals
  * @internal
  */
-export declare class Attributes {
-    size: number;
-    data: Attribute[];
+export declare class Attributes extends BufferView {
+    accessor size: number;
+    ['constructor']: typeof Attributes;
+    get byteSize(): number;
     has(name: string): boolean;
-    get(name: string): Attribute | undefined;
+    get(name: string): Uint8Array | undefined;
     set(name: string, value: Uint8Array): void;
     remove(name: string): boolean;
-    keys(): string[];
-    values(): Uint8Array[];
-    entries(): [string, Uint8Array][];
+    copyFrom(other: Attributes): void;
+    keys(): Generator<string, void, unknown>;
+    values(): Generator<Uint8Array<ArrayBufferLike>, void, unknown>;
+    entries(): Generator<(string | Uint8Array<ArrayBufferLike>)[], void, unknown>;
 }
 /**
  * @internal @hidden
@@ -56,75 +48,53 @@ export declare const _inode_fields: readonly ["ino", "data", "size", "mode", "fl
  * 1. 58 bytes. The first member was called `ino` but used as the ID for data.
  * 2. 66 bytes. Renamed the first member from `ino` to `data` and added a separate `ino` field
  * 3. 72 bytes. Changed the ID fields from 64 to 32 bits and added `flags`.
- * 4. (current) Added extended attributes. At least 128 bytes.
+ * 4. >= 128 bytes. Added extended attributes.
+ * 5. (current) 4 KiB. Changed flags
  * @internal @hidden
  */
-export declare const _inode_version = 4;
+export declare const _inode_version = 5;
 /**
- * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
- * @see `FS_*_FL` in `include/uapi/linux/fs.h` (around L250)
+ * Inode flags
+ * @see `S_*` in `include/linux/fs.h` (around L2325)
  * @experimental
  */
 export declare enum InodeFlags {
-    /** Secure deletion */
-    SecureRm = 1,
-    /** Undelete */
-    Undelete = 2,
-    /** Compress file */
-    Compress = 4,
-    /** Synchronous updates */
-    Sync = 8,
+    /** Writes are synced at once */
+    Sync = 1,
+    /** Do not update access times */
+    NoAtime = 2,
+    /** Append-only file */
+    Append = 4,
     /** Immutable file */
-    Immutable = 16,
-    /** Writes to file may only append */
-    Append = 32,
-    /** do not dump file */
-    NoDump = 64,
-    /** do not update atime */
-    NoAtime = 128,
-    Dirty = 256,
-    /** One or more compressed clusters */
-    CompressBlk = 512,
-    /** Don't compress */
-    NoCompress = 1024,
-    /** Encrypted file */
-    Encrypt = 2048,
-    /** btree format dir */
-    Btree = 4096,
-    /** hash-indexed directory */
-    Index = 4096,
-    /** AFS directory */
-    IMagic = 8192,
-    /** Reserved for ext3 */
-    JournalData = 16384,
-    /** file tail should not be merged */
-    NoTail = 32768,
-    /** dirsync behaviour (directories only) */
-    DirSync = 65536,
-    /** Top of directory hierarchies*/
-    TopDir = 131072,
-    /** Reserved for ext4 */
-    HugeFile = 262144,
-    /** Extents */
-    Extent = 524288,
-    /** Verity protected inode */
-    Verity = 1048576,
-    /** Inode used for large EA */
-    EaInode = 2097152,
-    /** Reserved for ext4 */
-    EofBlocks = 4194304,
-    /** Do not cow file */
-    NoCow = 8388608,
-    /** Inode is DAX */
-    Dax = 33554432,
-    /** Reserved for ext4 */
-    InlineData = 268435456,
-    /** Create with parents projid */
-    ProjInherit = 536870912,
-    /** Folder is case insensitive */
-    CaseFold = 1073741824,
-    /** reserved for ext2 lib */
-    Reserved = 2147483648
+    Immutable = 8,
+    /** removed, but still open directory */
+    Dead = 16,
+    /** Inode is not counted to quota */
+    NoQuota = 32,
+    /** Directory modifications are synchronous */
+    Dirsync = 64,
+    /** Do not update file c/mtime */
+    NoCMtime = 128,
+    /** Do not truncate: swapon got its bmaps */
+    SwapFile = 256,
+    /** Inode is fs-internal */
+    Private = 512,
+    /** Inode has an associated IMA struct */
+    IMA = 1024,
+    /** Automount/referral quasi-directory */
+    AutoMount = 2048,
+    /** no suid or xattr security attributes */
+    NoSec = 4096,
+    /** Direct Access, avoiding the page cache */
+    DAX = 8192,
+    /** Encrypted file (using fs/crypto/) */
+    Encrypted = 16384,
+    /** Casefolded file */
+    CaseFold = 32768,
+    /** Verity file (using fs/verity/) */
+    Verity = 65536,
+    /** File is in use by the kernel (eg. fs/cachefiles) */
+    KernelFile = 131072
 }
 /** User visible flags */
 export declare const userVisibleFlags = 253951;
@@ -135,40 +105,49 @@ export declare const userModifiableFlags = 229631;
  * @category Internals
  * @internal
  */
-export declare class Inode implements InodeLike {
-    constructor(data?: Uint8Array | Readonly<Partial<InodeLike>>);
-    data: number;
+export declare class Inode extends BufferView implements InodeLike {
+    constructor(...args: ConstructorParameters<typeof BufferView> | [Readonly<Partial<InodeLike>>]);
+    accessor data: number;
     /** For future use */
-    __data_old: number;
-    size: number;
-    mode: number;
-    nlink: number;
-    uid: number;
-    gid: number;
-    atimeMs: number;
-    birthtimeMs: number;
-    mtimeMs: number;
+    accessor __data_old: number;
+    accessor size: number;
+    accessor mode: number;
+    accessor nlink: number;
+    accessor uid: number;
+    accessor gid: number;
+    accessor atimeMs: number;
+    accessor birthtimeMs: number;
+    accessor mtimeMs: number;
     /**
      * The time the inode was changed.
      *
      * This is automatically updated whenever changed are made using `update()`.
      */
-    ctimeMs: number;
-    ino: number;
+    accessor ctimeMs: number;
+    accessor ino: number;
     /** For future use */
-    __ino_old: number;
-    flags: number;
+    accessor __ino_old: number;
+    accessor flags: number;
     /** For future use */
-    protected __after_flags: number;
+    protected accessor __after_flags: number;
     /**
      * The "version" of the inode/data.
-     *
      * Unrelated to the inode format!
      */
-    version: number;
-    /** Pad to 128 bytes */
-    protected __padding: never[];
-    attributes: Attributes;
+    accessor version: number;
+    /**
+     * Padding up to 128 bytes.
+     * This ensures there is enough room for expansion without breaking the ABI.
+     * @internal
+     */
+    protected accessor __padding: Uint8Array;
+    accessor attributes: Attributes;
+    /**
+     * Since the attribute data uses dynamic arrays,
+     * it is necessary to add this so attributes can be added.
+     * @internal @hidden
+     */
+    protected accessor __data: Uint8Array;
     toString(): string;
     toJSON(): InodeLike;
     /**
@@ -214,4 +193,3 @@ export declare function isFIFO(metadata: {
  * @internal
  */
 export declare function hasAccess($: V_Context, inode: Pick<InodeLike, 'mode' | 'uid' | 'gid'>, access: number): boolean;
-export {};