SysFS

Defined in: src/fs/sysfs.ts:6

Extends

KernelFS<KObject, Attribute, KLink>

Constructors

Constructor

new SysFS(): SysFS

Defined in: src/fs/sysfs.ts:7

Returns

SysFS

Overrides

KernelFS<KObject, Attribute, KLink>.constructor

Properties

_inodes

protected _inodes: Map<string, Inode>

Defined in: src/fs/kernfs.ts:33

Inherited from

KernelFS._inodes

_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

KernelFS._mountPoint

_nextIno

protected _nextIno: number = 1

Defined in: src/fs/kernfs.ts:31

Inherited from

KernelFS._nextIno

_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

KernelFS._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

KernelFS.attributes

enableFileSize

protected readonly enableFileSize: boolean = false

Defined in: src/fs/kernfs.ts:39

If set, statSync will get the actual file size

Inherited from

KernelFS.enableFileSize

initTime

protected readonly initTime: number

Defined in: src/fs/kernfs.ts:29

Inherited from

KernelFS.initTime

label?

optional label?: string

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

Inherited from

KernelFS.label

lookup

protected lookup: (path) => KEntry | null = sysfs_lookup

Defined in: src/fs/sysfs.ts:11

Resolve a path to a node.

Resolve a sysfs path.

Parameters

path

string

Returns

KEntry | null

null if nothing exists at path

Throws

ENOTDIR when part of path is used as a directory but isn’t a kobject

Returns

null or undefined when nothing is there

Throws

ENOTDIR when part of path is used as a directory but isn’t one

Overrides

KernelFS.lookup

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

KernelFS.name

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

KernelFS.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

KernelFS.uuid

Methods

_forget()

protected _forget(path): void

Defined in: src/fs/kernfs.ts:101

Forget the inode for path, and for everything that was under it

Parameters

path

string

Returns

void

Inherited from

KernelFS._forget

_getInode()

protected _getInode(path, node): Inode

Defined in: src/fs/kernfs.ts:80

The inode for a path, made the first time it is asked for and kept so that the times and the inode number stay put across calls.

Parameters

path

string

node

Attribute | KObject | KLink

Returns

Inode

Inherited from

KernelFS._getInode

_lookup()

protected _lookup(path): Attribute | KObject | KLink

Defined in: src/fs/kernfs.ts:58

Resolve a path to a node.

Parameters

path

string

Returns

Attribute | KObject | KLink

Throws

ENOENT when nothing is there, ENOTDIR when part of the path isn’t a directory

Inherited from

KernelFS._lookup

createFile()

abstract createFile(path, options): Promise<InodeLike<number>>

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

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

KernelFS.createFile

createFileSync()

createFileSync(_path, _options): InodeLike

Defined in: src/fs/kernfs.ts:151

Create the file at path with the given options.

Parameters

_path

string

_options

CreationOptions

Returns

InodeLike

Inherited from

KernelFS.createFileSync

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

DevTmpFS.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

KernelFS.existsSync

ioctl()

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

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

Promise<any>

Inherited from

KernelFS.ioctl

ioctlSync()

ioctlSync(context, command, …args): any

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

any

Inherited from

KernelFS.ioctlSync

is_dir()

protected is_dir(entry): entry is KObject

Defined in: src/fs/sysfs.ts:13

Parameters

entry

KEntry

Returns

entry is KObject

Overrides

KernelFS.is_dir

is_link()

protected is_link(entry): entry is KLink

Defined in: src/fs/sysfs.ts:17

Parameters

entry

KEntry

Returns

entry is KLink

Overrides

KernelFS.is_link

link()

abstract link(target, link): Promise<void>

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

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

KernelFS.link

linkSync()

linkSync(): void

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

Returns

void

Inherited from

KernelFS.linkSync

mkdir()

abstract mkdir(path, options): Promise<InodeLike<number>>

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

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

KernelFS.mkdir

mkdirSync()

mkdirSync(_path, _options): InodeLike

Defined in: src/fs/kernfs.ts:159

Parameters

_path

string

_options

CreationOptions

Returns

InodeLike

Inherited from

KernelFS.mkdirSync

read()

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

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

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start

number

The offset into the file to start reading from

end

number

The position in the file to stop reading

Returns

Promise<void>

Inherited from

KernelFS.read

readdir()

abstract readdir(path): Promise<string[]>

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

Parameters

path

string

Returns

Promise<string[]>

Inherited from

KernelFS.readdir

readdirSync()

readdirSync(path): string[]

Defined in: src/fs/kernfs.ts:116

Parameters

path

string

Returns

string[]

Inherited from

KernelFS.readdirSync

readSync()

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

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

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start

number

The offset into the file to start reading from

end

number

The position in the file to stop reading

Returns

void

Inherited from

KernelFS.readSync

ready()

ready(): Promise<void>

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

Returns

Promise<void>

Inherited from

KernelFS.ready

readySync()

readySync(): void

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

Returns

void

Inherited from

KernelFS.readySync

rename()

abstract rename(oldPath, newPath): Promise<void>

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

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

KernelFS.rename

renameSync()

renameSync(): void

Defined in: src/fs/kernfs.ts:143

Returns

void

Inherited from

KernelFS.renameSync

rmdir()

abstract rmdir(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

KernelFS.rmdir

rmdirSync()

rmdirSync(_path): void

Defined in: src/fs/kernfs.ts:163

Parameters

_path

string

Returns

void

Inherited from

KernelFS.rmdirSync

stat()

abstract stat(path): Promise<InodeLike<number>>

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

Parameters

path

string

Returns

Promise<InodeLike<number>>

Inherited from

KernelFS.stat

statSync()

statSync(path): InodeLike

Defined in: src/fs/kernfs.ts:105

Parameters

path

string

Returns

InodeLike

Inherited from

KernelFS.statSync

store()

protected store(node, value): void

Defined in: src/fs/kernfs.ts:68

Take what was written to a node.

Parameters

node

Attribute | KObject | KLink

value

string

Returns

void

Throws

EIO when there is nothing behind the file to take it

Inherited from

KernelFS.store

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

KernelFS.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

KernelFS.streamWrite

sync()

abstract sync(): Promise<void>

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

Returns

Promise<void>

Inherited from

KernelFS.sync

syncSync()

syncSync(): void

Defined in: src/fs/kernfs.ts:139

Returns

void

Inherited from

KernelFS.syncSync

toString()

toString(): string

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

Returns

string

Inherited from

KernelFS.toString

touch()

abstract touch(path, metadata): Promise<void>

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

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

KernelFS.touch

touchSync()

touchSync(path, metadata): void

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

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

KernelFS.touchSync

unlink()

abstract unlink(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

KernelFS.unlink

unlinkSync()

unlinkSync(_path): void

Defined in: src/fs/kernfs.ts:155

Parameters

_path

string

Returns

void

Inherited from

KernelFS.unlinkSync

usage()

usage(): UsageInfo

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

Default implementation.

Returns

UsageInfo

Todo

Implement

Inherited from

KernelFS.usage

write()

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

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

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>

Inherited from

KernelFS.write

writeSync()

writeSync(path, buffer, offset): void

Defined in: src/fs/kernfs.ts:131

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

Inherited from

KernelFS.writeSync

Contribute Sponsor