Interface FileSystemProviderWithFileReadStreamCapability

Readonly capabilities

Readonly onDidChangeCapabilities

Readonly onDidChangeFile

Readonly onFileWatchError

Optional access

• access(resource, mode?): Promise<void>

• Optional function that has to be implemented by FileSystemProviderWithAccessCapability. See FileSystemProviderWithAccessCapability#access for additional documentation.

  Parameters

  • resource: URI
  • Optional mode: number

  Returns Promise<void>

Optional close

• close(fd): Promise<void>

• Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#close for additional documentation.

  Parameters

  • fd: number

  Returns Promise<void>

Optional copy

• copy(from, to, opts): Promise<void>

• Optional function that has to be implemented by FileSystemProviderWithFileFolderCopyCapability. See FileSystemProviderWithFileFolderCopyCapability#copy} for additional documentation.

  Parameters

  • from: URI
  • to: URI
  • opts: FileOverwriteOptions

  Returns Promise<void>

delete

• delete(resource, opts): Promise<void>

• Delete the given resource.

  Parameters

  • resource: URI

    The URI of the resource to delete.
  • opts: FileDeleteOptions

    Options to define if files should be deleted recursively and if the trash should be used.

  Returns Promise<void>

Optional fsPath

• fsPath(resource): Promise<string>

• Optional function that has to be implemented by FileSystemProviderWithAccessCapability. See FileSystemProviderWithAccessCapability#fsPath for additional documentation.

  Parameters

  • resource: URI

  Returns Promise<string>

mkdir

• mkdir(resource): Promise<void>

• Create a new directory using the given resource uri.

  Parameters

  • resource: URI

    The URI of the new folder.

  Returns Promise<void>

Optional open

• open(resource, opts): Promise<number>

• Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#open for additional documentation.

  Parameters

  • resource: URI
  • opts: FileOpenOptions

  Returns Promise<number>

Optional read

• read(fd, pos, data, offset, length): Promise<number>

• Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#read for additional documentation.

  Parameters

  • fd: number
  • pos: number
  • data: Uint8Array
  • offset: number
  • length: number

  Returns Promise<number>

Optional readFile

• readFile(resource): Promise<Uint8Array>

• Optional function that has to be implemented by FileSystemProviderWithFileReadWriteCapability. See FileSystemProviderWithFileReadWriteCapability#readFile for additional documentation.

  Parameters

  • resource: URI

  Returns Promise<Uint8Array>

readdir

• readdir(resource): Promise<[string, FileType][]>

• Retrieve the content of a given directory.

  Parameters

  • resource: URI

    The URI of the directory.

  Returns Promise<[string, FileType][]>

  A map containing the FileType for each child resource, identified by name.

rename

• rename(from, to, opts): Promise<void>

• Rename a file or folder.

  Parameters

  • from: URI

    URI of the existing file or folder.
  • to: URI

    URI of the target location.
  • opts: FileOverwriteOptions

    Options to define if existing files should be overwritten.

  Returns Promise<void>

stat

• stat(resource): Promise<Stat>

• Retrieve metadata about a given file.

  Parameters

  • resource: URI

  Returns Promise<Stat>

  A promise of the metadata about the resource.

Optional updateFile

• updateFile(resource, changes, opts): Promise<FileUpdateResult>

• Optional function that has to be implemented by FileSystemProviderWithUpdateCapability. See FileSystemProviderWithUpdateCapability#updateFile for additional documentation.

  Parameters

  • resource: URI
  • changes: TextDocumentContentChangeEvent[]
  • opts: FileUpdateOptions

  Returns Promise<FileUpdateResult>

watch

• watch(resource, opts): Disposable

• Watch the given resource and react to changes by firing the FileSystemProvider#onDidChangeFile event.

  Parameters

  • resource: URI

    URI of the resource to be watched.
  • opts: WatchOptions

    Options to define if the resource should be watched recursively and to provide a set of resources that should be excluded from watching.

  Returns Disposable

  A Disposable that can be invoked to stop watching the resource.

Optional write

• write(fd, pos, data, offset, length): Promise<number>

• Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#write for additional documentation.

  Parameters

  • fd: number
  • pos: number
  • data: Uint8Array
  • offset: number
  • length: number

  Returns Promise<number>

Optional writeFile

• writeFile(resource, content, opts): Promise<void>

• Optional function that has to be implemented by FileSystemProviderWithFileReadWriteCapability. See FileSystemProviderWithFileReadWriteCapability#writeFile for additional documentation.

  Parameters

  • resource: URI
  • content: Uint8Array
  • opts: FileWriteOptions

  Returns Promise<void>