Interface FileSystemProviderWithOpenReadWriteCloseCapability

Subtype of FileSystemProvider that ensures that the optional functions, needed for providers that should be able to open,read, write or close files, are implemented.

interface FileSystemProviderWithOpenReadWriteCloseCapability {
    capabilities: FileSystemProviderCapabilities;
    onDidChangeCapabilities: Event<void>;
    onDidChangeFile: Event<readonly FileChange[]>;
    onFileWatchError: Event<void>;
    access?(resource, mode?): Promise<void>;
    close(fd): Promise<void>;
    copy?(from, to, opts): Promise<void>;
    delete(resource, opts): Promise<void>;
    fsPath?(resource): Promise<string>;
    mkdir(resource): Promise<void>;
    open(resource, opts): Promise<number>;
    read(fd, pos, data, offset, length): Promise<number>;
    readFile?(resource): Promise<Uint8Array>;
    readFileStream?(resource, opts, token): ReadableStreamEvents<Uint8Array>;
    readdir(resource): Promise<[string, FileType][]>;
    rename(from, to, opts): Promise<void>;
    stat(resource): Promise<Stat>;
    updateFile?(resource, changes, opts): Promise<FileUpdateResult>;
    watch(resource, opts): Disposable;
    write(fd, pos, data, offset, length): Promise<number>;
    writeFile?(resource, content, opts): Promise<void>;
}

Hierarchy (view full)

Implemented by

Properties

The FileSystemProviderCapabilities for this provider.

onDidChangeCapabilities: Event<void>
  • Event that is fired if the capabilities of this provider have changed.
onDidChangeFile: Event<readonly FileChange[]>

Event that is fired if a (watched) file in the filesystem of this provider has changed.

onFileWatchError: Event<void>

Event that is fired if an error occurred when watching files in the filesystem of this provider.

Methods

  • Read specified content from a given file descriptor into a data buffer.

    Parameters

    • fd: number

      The file descriptor referencing the file to read from.

    • pos: number

      The offset from the beginning of the file from which data should be read.

    • data: Uint8Array

      The buffer that the data will be written to.

    • offset: number

      The offset in the buffer at which to start writing.

    • length: number

      The number of bytes to read.

    Returns Promise<number>

    A promise of the number of bytes read.

  • Write specified content from the data buffer to the file referenced by the given file descriptor.

    Parameters

    • fd: number

      The file descriptor referencing the file to write to.

    • pos: number

      The offset from the beginning of the file where this data should be written.

    • data: Uint8Array
    • offset: number

      The part of the buffer to be read from.

    • length: number

      The number of bytes to write.

    Returns Promise<number>

    A promise of the number of bytes written.