Class CopyOnWriteFS`Internal`

Using a readable file system as a base, writes are done to a writable file system.

Hierarchy (View Summary)

FileSystem
- CopyOnWriteFS

Index

Constructors

constructor

new CopyOnWriteFS(
    readable: FileSystem,
    writable: FileSystem,
    journal?: Journal,
): CopyOnWriteFS
Parameters
- readable: FileSystem
  The file system that initially populates this file system.
- writable: FileSystem
  The file system to write modified files to.
- journal: Journal = ...
  The journal to use for persisting deletions
Returns CopyOnWriteFS
Overrides FileSystem.constructor
- Defined in src/backends/cow.ts:141

Properties

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Protected` `Internal`_uuid

_uuid: `${string}-${string}-${string}-${string}-${string}` = ...

The UUID of the file system.

`Readonly`attributes

attributes: ConstMap<
    FileSystemAttributes,
    keyof FileSystemAttributes,
    void
    | CaseFold
    | undefined,
> & Map<string, any> = ...

See

FileSystemAttributes

`Protected`inos

inos: Map<string, number> = ...

Inode numbers presented to the VFS for each path.

The readable and writable layers allocate inode numbers independently, so they can collide. They can not be used as-is, since the VFS uses ino to tell files apart. This also keeps a file's inode number stable when it is copied up to the writable layer.

`Readonly`journal

journal: Journal = ...

The journal to use for persisting deletions

`Optional`label

label?: string

`Readonly`name

name: string

The name for this file system. For example, tmpfs for an in memory one

`Readonly`readable

readable: FileSystem

The file system that initially populates this file system.

`Readonly`type

type: number

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

`Readonly`writable

writable: FileSystem

The file system to write modified files to.

Accessors

uuid

get uuid(): `${string}-${string}-${string}-${string}-${string}`
Returns `${string}-${string}-${string}-${string}-${string}`
Inherited from FileSystem.uuid
- Defined in src/internal/filesystem.ts:169

Methods

createFile

createFile(path: string, options: CreationOptions): Promise<InodeLike<number>>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Overrides FileSystem.createFile
- Defined in src/backends/cow.ts:291

createFileSync

createFileSync(path: string, options: CreationOptions): InodeLike
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides FileSystem.createFileSync
- Defined in src/backends/cow.ts:298

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from FileSystem.exists
- Defined in src/internal/filesystem.ts:255

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from FileSystem.existsSync
- Defined in src/internal/filesystem.ts:267

isDeleted

isDeleted(path: string): boolean
Parameters
- path: string
Returns boolean
- Defined in src/backends/cow.ts:160

link

link(srcpath: string, dstpath: string): Promise<void>
Parameters
- srcpath: string
- dstpath: string
Returns Promise<void>
Overrides FileSystem.link
- Defined in src/backends/cow.ts:305

linkSync

linkSync(srcpath: string, dstpath: string): void
Parameters
- srcpath: string
- dstpath: string
Returns void
Overrides FileSystem.linkSync
- Defined in src/backends/cow.ts:311

mkdir

mkdir(path: string, options: CreationOptions): Promise<InodeLike<number>>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Overrides FileSystem.mkdir
- Defined in src/backends/cow.ts:377

mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides FileSystem.mkdirSync
- Defined in src/backends/cow.ts:385

read

read(
    path: string,
    buffer: Uint8Array,
    offset: number,
    end: number,
): Promise<void>
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
- end: number
  The position in the file to stop reading
Returns Promise<void>
Overrides FileSystem.read
- Defined in src/backends/cow.ts:213

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides FileSystem.readdir
- Defined in src/backends/cow.ts:393

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides FileSystem.readdirSync
- Defined in src/backends/cow.ts:411

readSync

readSync(path: string, buffer: Uint8Array, offset: number, end: number): void
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
- end: number
  The position in the file to stop reading
Returns void
Overrides FileSystem.readSync
- Defined in src/backends/cow.ts:219

ready

ready(): Promise<void>
Returns Promise<void>
Overrides FileSystem.ready
- Defined in src/backends/cow.ts:131

readySync

readySync(): void
Returns void
Overrides FileSystem.readySync
- Defined in src/backends/cow.ts:136

`Protected`remapIno

remapIno(path: string, inode: InodeLike): InodeLike
Replaces the layer's inode number with the public one for path
Parameters
- path: string
- inode: InodeLike
Returns InodeLike
- Defined in src/backends/cow.ts:185

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Overrides FileSystem.rename
- Defined in src/backends/cow.ts:233

`Protected`renameInos

renameInos(oldPath: string, newPath: string): void
Moves the public inode numbers for a rename, including a directory's descendants
Parameters
- oldPath: string
- newPath: string
Returns void
- Defined in src/backends/cow.ts:175

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides FileSystem.renameSync
- Defined in src/backends/cow.ts:248

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.rmdir
- Defined in src/backends/cow.ts:347

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Overrides FileSystem.rmdirSync
- Defined in src/backends/cow.ts:362

stat

stat(path: string): Promise<InodeLike<number>>
Parameters
- path: string
Returns Promise<InodeLike<number>>
Overrides FileSystem.stat
- Defined in src/backends/cow.ts:263

statSync

statSync(path: string): InodeLike
Parameters
- path: string
Returns InodeLike
Overrides FileSystem.statSync
- Defined in src/backends/cow.ts:272

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Overrides FileSystem.streamRead
- Defined in src/backends/cow.ts:441

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Overrides FileSystem.streamWrite
- Defined in src/backends/cow.ts:445

sync

sync(): Promise<void>
Returns Promise<void>
Overrides FileSystem.sync
- Defined in src/backends/cow.ts:205

syncSync

syncSync(): void
Returns void
Overrides FileSystem.syncSync
- Defined in src/backends/cow.ts:209

toString

toString(): string
Returns string
Inherited from FileSystem.toString
- Defined in src/internal/filesystem.ts:195

touch

touch(path: string, metadata: InodeLike): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns Promise<void>
Overrides FileSystem.touch
- Defined in src/backends/cow.ts:281

touchSync

touchSync(path: string, metadata: InodeLike): void
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns void
Overrides FileSystem.touchSync
- Defined in src/backends/cow.ts:286

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.unlink
- Defined in src/backends/cow.ts:317

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Overrides FileSystem.unlinkSync
- Defined in src/backends/cow.ts:332

usage

usage(): UsageInfo
Returns UsageInfo

Todo
Consider trying to track information on the writable as well
Overrides FileSystem.usage
- Defined in src/backends/cow.ts:201

write

write(path: string, buffer: Uint8Array, offset: number): Promise<void>
Writes a buffer to a file
Parameters
- path: string
- buffer: Uint8Array
  The buffer to write. You must set the byteOffset and byteLength appropriately!
- offset: number
  The offset in the file to start writing
Returns Promise<void>
Overrides FileSystem.write
- Defined in src/backends/cow.ts:223

writeSync

writeSync(path: string, buffer: Uint8Array, offset: number): void
Writes a buffer to a file
Parameters
- path: string
- buffer: Uint8Array
  The buffer to write. You must set the byteOffset and byteLength appropriately!
- offset: number
  The offset in the file to start writing
Returns void
Overrides FileSystem.writeSync
- Defined in src/backends/cow.ts:228

Class CopyOnWriteFSInternal

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CopyOnWriteFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Protectedinos

Readonlyjournal

Optionallabel

Readonlyname

Readonlyreadable

Readonlytype

Readonlywritable

Accessors

uuid

Returns `${string}-${string}-${string}-${string}-${string}`

Methods

createFile

Parameters

Returns Promise<InodeLike<number>>

createFileSync

Parameters

Returns InodeLike

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

isDeleted

Parameters

Returns boolean

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

mkdir

Parameters

Returns Promise<InodeLike<number>>

mkdirSync

Parameters

Returns InodeLike

read

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

readSync

Parameters

Returns void

ready

Returns Promise<void>

readySync

Returns void

ProtectedremapIno

Parameters

Returns InodeLike

rename

Parameters

Returns Promise<void>

ProtectedrenameInos

Parameters

Returns void

renameSync

Class CopyOnWriteFS`Internal`

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Protected`inos

`Readonly`journal

`Optional`label

`Readonly`name

`Readonly`readable

`Readonly`type

`Readonly`writable

`Protected`remapIno

`Protected`renameInos