KC's Workspace
    Preparing search index...

    Class Superblock

    Represents a filesystem superblock, which is the root of a virtual filesystem in Linux.

    https://lxr.linux.no/linux+v3.11.2/include/linux/fs.h#L1242

    Index

    Constructors

    constructor

    Properties

    close fds ino inodes link maxFiles mkdir mkdirp open openFiles read readv releasedFds releasedInos rename rm rmdir root symlink unlink writeFile fd

    Methods

    _toJSON closeFile createLink createNode deleteLink deleteNode fromJSON fromNestedJSON getFileByFd getFileByFdOrThrow getLink getLinkAsDirOrThrow getLinkOrThrow getLinkParent getLinkParentAsDirOrThrow getResolvedLink getResolvedLinkOrThrow getResolvedLinkResult mountSync openFile openLink reset resolveSymlinks toJSON walk write fromJSON fromNestedJSON

    Constructors

    • Parameters

      • Optionalprops: {}

      Returns Superblock

    Properties

    close: (fd: number) => void
    fds: { [fd: number]: File }
    ino: number
    inodes: { [ino: number]: Node }
    link: (filename1: string, filename2: string) => void
    maxFiles: number
    mkdir: (filename: string, modeNum: number) => void
    mkdirp: (filename: string, modeNum: number) => string | undefined

    Creates directory tree recursively.

    open: (
        filename: string,
        flagsNum: number,
        modeNum: number,
        resolveSymlinks?: boolean,
    ) => number
    openFiles: number
    read: (
        fd: number,
        buffer:
            | Buffer<ArrayBufferLike>
            | DataView<ArrayBufferLike>
            | ArrayBufferView<ArrayBufferLike>,
        offset: number,
        length: number,
        position: number | null,
    ) => number
    readv: (
        fd: number,
        buffers: ArrayBufferView<ArrayBufferLike>[],
        position: number | null,
    ) => number
    releasedFds: number[]
    releasedInos: number[]
    rename: (oldPathFilename: string, newPathFilename: string) => void
    rm: (filename: string, force?: boolean, recursive?: boolean) => void
    rmdir: (filename: string, recursive?: boolean) => void
    root: Link
    symlink: (targetFilename: string, pathFilename: string) => Link
    unlink: (filename: string) => void
    writeFile: (id: TFileId, buf: Buffer, flagsNum: number, modeNum: number) => void
    fd: number

    Global file descriptor counter. UNIX file descriptors start from 0 and go sequentially up, so here, in order not to conflict with them, we choose some big number and descrease the file descriptor of every new opened file.

    This should not be static, right?

    Methods

    _toJSON

    • _toJSON(
          link?: Link,
          json?: {},
          path?: string,
          asBuffer?: boolean,
      ): DirectoryJSON<string | null>

      Parameters

      • Optionallink: Link
      • Optionaljson: {}
      • Optionalpath: string
      • OptionalasBuffer: boolean

      Returns DirectoryJSON<string | null>

    • Parameters

      Returns void

    • Returns Link

    • Parameters

      • parent: Link
      • name: string
      • OptionalisDirectory: boolean
      • Optionalmode: number

      Returns Link

    • Parameters

      • mode: number

      Returns Node

    • Parameters

      Returns boolean

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • fd: number

      Returns File

    • Parameters

      • fd: number
      • OptionalfuncName: string

      Returns File

    • Parameters

      • steps: string[]

      Returns Link | null

    • Just like getLinkOrThrow, but also verifies that the link is a directory.

      Parameters

      • filename: string
      • OptionalfuncName: string

      Returns Link

    • Parameters

      • filename: string
      • OptionalfuncName: string

      Returns Link

    • Parameters

      • steps: string[]

      Returns Link | null

    • Parameters

      • filenameOrSteps: string | string[]
      • OptionalfuncName: string

      Returns Link

    • Parameters

      • filenameOrSteps: string | string[]

      Returns Link | null

    • Just like getLinkOrThrow, but also dereference/resolves symbolic links.

      Parameters

      • filename: string
      • OptionalfuncName: string

      Returns Link

    • Parameters

      • filename: string
      • OptionalfuncName: string

      Returns Result<Link, StatError>

    • Parameters

      Returns void

    • Parameters

      • filename: string
      • flagsNum: number
      • modeNum: number | undefined
      • OptionalresolveSymlinks: boolean

      Returns File

    • Parameters

      • link: Link
      • flagsNum: number
      • OptionalresolveSymlinks: boolean

      Returns File

    • Returns void

    • Parameters

      Returns Link | null

    • Parameters

      • Optionalpaths: PathLike | PathLike[]
      • Optionaljson: {}
      • OptionalisRelative: boolean
      • OptionalasBuffer: boolean

      Returns DirectoryJSON<string | null>

    • Parameters

      • steps: string[]
      • resolveSymlinks: boolean
      • checkExistence: boolean
      • checkAccess: boolean
      • OptionalfuncName: string

      Returns Result<Link | null, StatError>

    • Parameters

      • filename: string
      • resolveSymlinks: boolean
      • checkExistence: boolean
      • checkAccess: boolean
      • OptionalfuncName: string

      Returns Result<Link | null, StatError>

    • Parameters

      • link: Link
      • resolveSymlinks: boolean
      • checkExistence: boolean
      • checkAccess: boolean
      • OptionalfuncName: string

      Returns Result<Link | null, StatError>

    • Parameters

      • stepsOrFilenameOrLink: string | string[] | Link
      • resolveSymlinks: boolean
      • checkExistence: boolean
      • checkAccess: boolean
      • OptionalfuncName: string

      Returns Result<Link | null, StatError>

    • Parameters

      • fd: number
      • buf: Buffer
      • Optionaloffset: number
      • Optionallength: number
      • Optionalposition: number | null

      Returns number

    • Parameters

      Returns Superblock

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods