Theia API Documentation v1.65.0
    Preparing search index...
    interface RemoteFileSystemServer {
        access(resource: string, mode?: number): Promise<void>;
        close(fd: number): Promise<void>;
        copy(
            source: string,
            target: string,
            opts: FileOverwriteOptions,
        ): Promise<void>;
        delete(resource: string, opts: FileDeleteOptions): Promise<void>;
        dispose(): void;
        fsPath(resource: string): Promise<string>;
        getCapabilities(): Promise<FileSystemProviderCapabilities>;
        getClient?(): undefined | RemoteFileSystemClient;
        getReadOnlyMessage(): Promise<undefined | MarkdownString>;
        mkdir(resource: string): Promise<void>;
        open(resource: string, opts: FileOpenOptions): Promise<number>;
        read(
            fd: number,
            pos: number,
            length: number,
        ): Promise<{ bytes: Uint8Array; bytesRead: number }>;
        readdir(resource: string): Promise<[string, FileType][]>;
        readFile(resource: string): Promise<Uint8Array>;
        readFileStream(
            resource: string,
            handle: number,
            opts: FileReadStreamOptions,
            token: CancellationToken,
        ): Promise<void>;
        rename(
            source: string,
            target: string,
            opts: FileOverwriteOptions,
        ): Promise<void>;
        setClient(client: undefined | RemoteFileSystemClient): void;
        stat(resource: string): Promise<Stat>;
        unwatch(watcher: number): Promise<void>;
        updateFile(
            resource: string,
            changes: TextDocumentContentChangeEvent[],
            opts: FileUpdateOptions,
        ): Promise<FileUpdateResult>;
        watch(watcher: number, resource: string, opts: WatchOptions): Promise<void>;
        write(
            fd: number,
            pos: number,
            data: Uint8Array,
            offset: number,
            length: number,
        ): Promise<number>;
        writeFile(
            resource: string,
            content: Uint8Array,
            opts: FileWriteOptions,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    • Dispose this object.

      Returns void

    • If this server is a proxy to a remote server then a client is used as a local object to handle RPC messages from the remote server.

      Parameters

      Returns void