DevTmpFS

Defined in: src/fs/devtmpfs.ts:76

A temporary file system that manages and interfaces with devices

Extends

StoreFS<InMemoryStore>

Constructors

Constructor

new DevTmpFS(): DevTmpFS

Defined in: src/fs/devtmpfs.ts:77

Returns

DevTmpFS

Overrides

StoreFS<InMemoryStore>.constructor

Properties

_initialized

protected _initialized: boolean

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:41

Inherited from

StoreFS._initialized

_mountPoint?

protected optional _mountPoint?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:145

Internal

The last place this file system was mounted

Inherited from

StoreFS._mountPoint

_uuid

protected _uuid: `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:151

Internal

The UUID of the file system.

Inherited from

StoreFS._uuid

attributes

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

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:156

See

FileSystemAttributes

Inherited from

StoreFS.attributes

label?

optional label?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:140

Inherited from

StoreFS.label

name

readonly name: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:139

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

Inherited from

StoreFS.name

store

protected readonly store: InMemoryStore

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:14

Inherited from

StoreFS.store

type

readonly type: number

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:134

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

Inherited from

StoreFS.type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:152

Returns

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

Inherited from

StoreFS.uuid

Methods

_add()

_add(ino, path): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:32

Add a inode/path pair

Parameters

ino

number

path

string

Returns

void

Inherited from

StoreFS._add

_create_path()

protected _create_path(path): void

Defined in: src/fs/devtmpfs.ts:112

mkdir -p for the parents of a node in a subdirectory

Parameters

path

string

Returns

void

_delete_path()

protected _delete_path(path): void

Defined in: src/fs/devtmpfs.ts:122

Remove the directories a node was in, as long as they are empty

Parameters

path

string

Returns

void

_device()

_device(path, inode?): DeviceFileWithOps | undefined

Defined in: src/fs/devtmpfs.ts:172

The driver handling the node at path, if it is a device node.

Parameters

path

string

inode?

InodeLike = ...

The node’s inode, for callers that already have an authoritative one

Returns

DeviceFileWithOps | undefined

Throws

ENXIO when nothing has claimed the node’s device number

_mount()

protected _mount(): void

Defined in: src/fs/devtmpfs.ts:96

Take over as the devtmpfs and create nodes for devices registered before we existed

Returns

void

_move()

_move(from, to): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:40

Move paths in the tables

Parameters

from

string

to

string

Returns

void

Inherited from

StoreFS._move

_path()

_path(id): string | undefined

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:28

Gets the first path associated with an inode

Parameters

id

number

Returns

string | undefined

Inherited from

StoreFS._path

_remove()

_remove(ino): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:36

Remove a inode/path pair

Parameters

ino

number

Returns

void

Inherited from

StoreFS._remove

allocNew()

protected allocNew(path): number

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:126

Allocates a new ID and adds the ID/path

Parameters

path

string

Returns

number

Inherited from

StoreFS.allocNew

checkRoot()

checkRoot(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:93

Checks if the root directory exists. Creates it if it doesn’t.

Returns

Promise<void>

Inherited from

StoreFS.checkRoot

checkRootSync()

checkRootSync(): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:97

Checks if the root directory exists. Creates it if it doesn’t.

Returns

void

Inherited from

StoreFS.checkRootSync

commitNew()

protected commitNew(path, options, data): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:134

Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.

Parameters

path

string

The path to the new file.

options

CreationOptions

The options to create the new file with.

data

Uint8Array

The data to store at the file’s data node.

Returns

Promise<Inode>

Inherited from

StoreFS.commitNew

commitNewSync()

protected commitNewSync(path, options, data): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:143

Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.

Parameters

path

string

The path to the new file.

options

CreationOptions

The options to create the new file with.

data

Uint8Array

The data to store at the file’s data node.

Returns

Inode

The Inode for the new file.

Inherited from

StoreFS.commitNewSync

create_node()

create_node(device): void

Defined in: src/fs/devtmpfs.ts:132

Internal

Parameters

device

Device

Returns

void

createFile()

createFile(path, options): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:67

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

StoreFS.createFile

createFileSync()

createFileSync(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:68

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

StoreFS.createFileSync

createIndex()

createIndex(): Promise<Index>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:56

Returns

Promise<Index>

Inherited from

StoreFS.createIndex

createIndexSync()

createIndexSync(): Index

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:57

Returns

Index

Inherited from

StoreFS.createIndexSync

delete_node()

delete_node(device): void

Defined in: src/fs/devtmpfs.ts:147

Internal

Only remove a node if it is one we created and it still refers to this device, so a node someone replaced is left alone. This is Linux’s dev_mynode.

Parameters

device

Device

Returns

void

exists()

exists(path): Promise<boolean>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:204

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

StoreFS.exists

existsSync()

existsSync(path): boolean

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

StoreFS.existsSync

findInode()

protected findInode(tx, path): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:116

Finds the Inode of path.

Parameters

tx

WrappedTransaction

path

string

The path to look up.

Returns

Promise<Inode>

Todo

memoize/cache

Inherited from

StoreFS.findInode

findInodeSync()

protected findInodeSync(tx, path): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:123

Finds the Inode of path.

Parameters

tx

WrappedTransaction

path

string

The path to look up.

Returns

Inode

The Inode of the path p.

Todo

memoize/cache

Inherited from

StoreFS.findInodeSync

ioctl()

ioctl(context, command, …args): Promise<unknown>

Defined in: src/fs/devtmpfs.ts:238

Internal

Parameters

context

IoctlContext

command

number

args

…unknown[]

Returns

Promise<unknown>

Overrides

StoreFS.ioctl

ioctlSync()

ioctlSync(context, command, …args): unknown

Defined in: src/fs/devtmpfs.ts:232

Internal

Parameters

context

IoctlContext

command

number

args

…unknown[]

Returns

unknown

Overrides

StoreFS.ioctlSync

link()

link(target, link): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:79

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

StoreFS.link

linkSync()

linkSync(target, link): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:80

Parameters

target

string

link

string

Returns

void

Inherited from

StoreFS.linkSync

loadIndex()

loadIndex(index): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:50

Load an index into the StoreFS. You must manually add non-directory files

Parameters

index

Index

Returns

Promise<void>

Inherited from

StoreFS.loadIndex

loadIndexSync()

loadIndexSync(index): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:55

Load an index into the StoreFS. You must manually add non-directory files

Parameters

index

Index

Returns

void

Inherited from

StoreFS.loadIndexSync

mkdir()

mkdir(path, options): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:73

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

StoreFS.mkdir

mkdirSync()

mkdirSync(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:74

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

StoreFS.mkdirSync

mknodSync()

mknodSync(path, mode, rdev): InodeLike

Defined in: src/fs/devtmpfs.ts:106

Create a device node, like mknod.

Parameters

path

string

mode

number

rdev

number

The device number

Returns

InodeLike

read()

read(path, buffer, start, end): Promise<void>

Defined in: src/fs/devtmpfs.ts:208

Parameters

path

string

buffer

Uint8Array

start

number

end

number

Returns

Promise<void>

Overrides

StoreFS.read

read_device()

read_device(file, buffer, start, end): number

Defined in: src/fs/devtmpfs.ts:197

Read from a device node and say how much came back.

This is the same call readSync makes; it exists because a terminal handing over one line is a short read, and going through the VFS loses the count.

Parameters

file

DeviceFileWithOps

buffer

Uint8Array

start

number

end

number

Returns

number

readdir()

readdir(path): Promise<string[]>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:75

Parameters

path

string

Returns

Promise<string[]>

Inherited from

StoreFS.readdir

readdirSync()

readdirSync(path): string[]

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:76

Parameters

path

string

Returns

string[]

Inherited from

StoreFS.readdirSync

readSync()

readSync(path, buffer, start, end): void

Defined in: src/fs/devtmpfs.ts:183

Parameters

path

string

buffer

Uint8Array

start

number

end

number

Returns

void

Overrides

StoreFS.readSync

ready()

ready(): Promise<void>

Defined in: src/fs/devtmpfs.ts:85

Returns

Promise<void>

Overrides

StoreFS.ready

readySync()

readySync(): void

Defined in: src/fs/devtmpfs.ts:90

Returns

void

Overrides

StoreFS.readySync

remove()

protected remove(path, isDir): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:149

Remove all traces of path from the file system.

Parameters

path

string

The path to remove from the file system.

isDir

boolean

Does the path belong to a directory, or a file?

Returns

Promise<void>

Inherited from

StoreFS.remove

removeSync()

protected removeSync(path, isDir): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:155

Remove all traces of path from the file system.

Parameters

path

string

The path to remove from the file system.

isDir

boolean

Does the path belong to a directory, or a file?

Returns

void

Inherited from

StoreFS.removeSync

rename()

rename(oldPath, newPath): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:61

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Todo

Make rename compatible with the cache.

Inherited from

StoreFS.rename

renameSync()

renameSync(oldPath, newPath): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:62

Parameters

oldPath

string

newPath

string

Returns

void

Inherited from

StoreFS.renameSync

rmdir()

rmdir(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:71

Parameters

path

string

Returns

Promise<void>

Inherited from

StoreFS.rmdir

rmdirSync()

rmdirSync(path): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:72

Parameters

path

string

Returns

void

Inherited from

StoreFS.rmdirSync

stat()

stat(path): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:63

Parameters

path

string

Returns

Promise<Inode>

Inherited from

StoreFS.stat

statSync()

statSync(path): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:64

Parameters

path

string

Returns

Inode

Inherited from

StoreFS.statSync

streamRead()

streamRead(path, options): ReadableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:243

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

StoreFS.streamRead

streamWrite()

streamWrite(path, options): WritableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:248

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

StoreFS.streamWrite

sync()

sync(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:77

Returns

Promise<void>

Inherited from

StoreFS.sync

syncSync()

syncSync(): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:78

Returns

void

Inherited from

StoreFS.syncSync

toString()

toString(): string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:168

Returns

string

Inherited from

StoreFS.toString

touch()

touch(path, metadata): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:65

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

StoreFS.touch

touchSync()

touchSync(path, metadata): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:66

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

StoreFS.touchSync

unlink()

unlink(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:69

Parameters

path

string

Returns

Promise<void>

Inherited from

StoreFS.unlink

unlinkSync()

unlinkSync(path): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:70

Parameters

path

string

Returns

void

Inherited from

StoreFS.unlinkSync

usage()

usage(): UsageInfo

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:45

Default implementation.

Returns

UsageInfo

Todo

Implement

Inherited from

StoreFS.usage

write()

write(path, buffer, offset): Promise<void>

Defined in: src/fs/devtmpfs.ts:224

Parameters

path

string

buffer

Uint8Array

offset

number

Returns

Promise<void>

Overrides

StoreFS.write

write_device()

write_device(file, buffer, offset): number

Defined in: src/fs/devtmpfs.ts:203

The write half of read_device, for a device that can take less than it was offered

Parameters

file

DeviceFileWithOps

buffer

Uint8Array

offset

number

Returns

number

writeSync()

writeSync(path, buffer, offset): void

Defined in: src/fs/devtmpfs.ts:216

Parameters

path

string

buffer

Uint8Array

offset

number

Returns

void

Overrides

StoreFS.writeSync

Contribute Sponsor