Interface DeviceDriver<TData>

A device driver

interface DeviceDriver<TData = any> {
    isBuffered?: boolean;
    name: string;
    singleton?: boolean;
    close(file: DeviceFile<TData>): void;
    init(ino: number, options: object): DeviceInit<TData>;
    read(
        file: DeviceFile<TData>,
        buffer: ArrayBufferView<ArrayBufferLike>,
        offset?: number,
        length?: number,
        position?: number,
    ): number;
    readD(
        device: Device<TData>,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        end: number,
    ): void;
    sync(file: DeviceFile<TData>): void;
    write(
        file: DeviceFile<TData>,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        length: number,
        position?: number,
    ): number;
    writeD(
        device: Device<TData>,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
    ): void;
}

Type Parameters

  • TData = any

Properties

isBuffered? name singleton?

Methods

init?

File operations

close? read? readD sync? write? writeD

Properties

OptionalisBuffered

isBuffered?: boolean

Whether the device is buffered (a "block" device) or unbuffered (a "character" device)

Default

false

name

name: string

The name of the device driver

Optionalsingleton

singleton?: boolean

If true, only a single device can exist per device FS. Note that if this is unset or false, auto-named devices will have a number suffix

Methods

Optionalinit

File operations

Optionalclose

Optionalread

  • read(
        file: DeviceFile<TData>,
        buffer: ArrayBufferView<ArrayBufferLike>,
        offset?: number,
        length?: number,
        position?: number,
    ): number

  • Synchronously read from a device file

    Parameters

    • file: DeviceFile<TData>
    • buffer: ArrayBufferView<ArrayBufferLike>
    • Optionaloffset: number
    • Optionallength: number
    • Optionalposition: number

    Returns number

    Deprecated

    Todo

    [BREAKING] Remove

readD

  • readD(
        device: Device<TData>,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        end: number,
    ): void

  • Synchronously read from a device.

    Parameters

    • device: Device<TData>
    • buffer: Uint8Array<ArrayBufferLike>
    • offset: number
    • end: number

    Returns void

    Todo

    [BREAKING] Rename to read

Optionalsync

Optionalwrite

  • write(
        file: DeviceFile<TData>,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        length: number,
        position?: number,
    ): number

  • Synchronously write to a device file

    Parameters

    • file: DeviceFile<TData>
    • buffer: Uint8Array<ArrayBufferLike>
    • offset: number
    • length: number
    • Optionalposition: number

    Returns number

    Deprecated

    Todo

    [BREAKING] Remove

writeD

  • writeD(
        device: Device<TData>,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
    ): void

  • Synchronously write to a device

    Parameters

    • device: Device<TData>
    • buffer: Uint8Array<ArrayBufferLike>
    • offset: number

    Returns void

    Todo

    [BREAKING] Rename to write

Settings

Member Visibility

On This Page

Properties
Methods
File operations