Class LocalRemoteFileSystemProvider

ReadonlyonDidChangeCapabilities

ReadonlyonDidChangeFile

ReadonlyonDidChangeReadOnlyMessage

ReadonlyonFileWatchError

Readonlyready

capabilities

• get capabilities(): FileSystemProviderCapabilities

  The FileSystemProviderCapabilities for this provider.

  Returns FileSystemProviderCapabilities

readOnlyMessage

• get readOnlyMessage(): undefined | MarkdownString

  Returns undefined | MarkdownString

access

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

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

  Parameters

  • resource: URI
  • Optionalmode: number

  Returns Promise<void>

close

• close(fd: number): Promise<void>

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

  Parameters

  • fd: number

  Returns Promise<void>

copy

• copy(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>

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

  Parameters

  • resource: URI
  • target: URI
  • opts: FileOverwriteOptions

  Returns Promise<void>

delete

• delete(resource: URI, opts: FileDeleteOptions): 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>

dispose

• dispose(): void

  Dispose this object.

  Returns void

fsPath

• fsPath(resource: URI): 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: URI): Promise<void>

  Create a new directory using the given resource uri.

  Parameters

  • resource: URI

    The URI of the new folder.

  Returns Promise<void>

open

• open(resource: URI, opts: FileOpenOptions): 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>

read

• read(
      fd: number,
      pos: number,
      data: Uint8Array,
      offset: number,
      length: number,
  ): 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>

readdir

• readdir(resource: URI): 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.

readFile

• readFile(resource: URI): Promise<Uint8Array>

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

  Parameters

  • resource: URI

  Returns Promise<Uint8Array>

readFileStream

• readFileStream(
      resource: URI,
      opts: FileReadStreamOptions,
      token: CancellationToken,
  ): ReadableStreamEvents<Uint8Array>

  Optional function that has to be implemented by FileSystemProviderWithFileReadStreamCapability. See FileSystemProviderWithFileReadStreamCapability#readFileStream for additional documentation.

  Parameters

  • resource: URI
  • opts: FileReadStreamOptions
  • token: CancellationToken

  Returns ReadableStreamEvents<Uint8Array>

rename

• rename(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>

  Rename a file or folder.

  Parameters

  • resource: URI
  • target: URI
  • opts: FileOverwriteOptions

    Options to define if existing files should be overwritten.

  Returns Promise<void>

stat

• stat(resource: URI): Promise<Stat>

  Retrieve metadata about a given file.

  Parameters

  • resource: URI

  Returns Promise<Stat>

  A promise of the metadata about the resource.

updateFile

• updateFile(
      resource: URI,
      changes: TextDocumentContentChangeEvent[],
      opts: FileUpdateOptions,
  ): 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: URI, options: WatchOptions): 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.

  • options: WatchOptions

  Returns Disposable

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

write

• write(
      fd: number,
      pos: number,
      data: Uint8Array,
      offset: number,
      length: number,
  ): 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>

writeFile

• writeFile(
      resource: URI,
      content: Uint8Array,
      opts: FileWriteOptions,
  ): 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>