Class FileResource

Implements

  • Resource

Constructors

constructor

Properties

_version acceptTextOnly doSaveContentChanges fileService limits onDidChangeContents onDidChangeContentsEmitter onDidChangeReadOnly onDidChangeReadOnlyEmitter options saveContentChanges? saveContents? saveStream? toDispose uri writingLock

Accessors

encoding readOnly version

Methods

dispose doWrite guessEncoding isInSync readContents readStream shouldOpenAsText shouldOverwrite sync updateReadOnly updateSavingContentChanges

Constructors

constructor

Properties

Protected _version

_version: undefined | FileResourceVersion

Protected acceptTextOnly

acceptTextOnly: boolean = true

Protected doSaveContentChanges

doSaveContentChanges: undefined | ((changes, options?) => Promise<void>) = ...

Type declaration

    • (changes, options?): Promise<void>

    • Applies incremental content changes to this resource.

      If a resource supports versioning clients can pass some version to check against it, if it is not provided latest version is used. It updates version to latest.

      Parameters

      • changes: TextDocumentContentChangeEvent[]
      • Optional options: ResourceSaveOptions

      Returns Promise<void>

      Throws

      ResourceError.NotFound if a resource not found or was not read yet

      Throws

      ResourceError.OutOfSync if latest resource version is out of sync with the given

Protected Readonly fileService

fileService: FileService

Protected limits

limits: undefined | {
    memory?: number;
    size?: number;
}

Type declaration

  • Optional Readonly memory?: number
  • Optional Readonly size?: number

Readonly onDidChangeContents

onDidChangeContents: Event<void> = ...

Protected Readonly onDidChangeContentsEmitter

onDidChangeContentsEmitter: Emitter<void> = ...

Readonly onDidChangeReadOnly

onDidChangeReadOnly: Event<boolean | MarkdownString> = ...

Protected Readonly onDidChangeReadOnlyEmitter

onDidChangeReadOnlyEmitter: Emitter<boolean | MarkdownString> = ...

Protected Readonly options

options: FileResourceOptions

Optional saveContentChanges

saveContentChanges?: ((changes, options?) => Promise<void>)

Type declaration

    • (changes, options?): Promise<void>

    • Applies incremental content changes to this resource.

      If a resource supports versioning clients can pass some version to check against it, if it is not provided latest version is used. It updates version to latest.

      Parameters

      • changes: TextDocumentContentChangeEvent[]
      • Optional options: ResourceSaveOptions

      Returns Promise<void>

      Throws

      ResourceError.NotFound if a resource not found or was not read yet

      Throws

      ResourceError.OutOfSync if latest resource version is out of sync with the given

Optional saveContents

saveContents?: ((content, options?) => Promise<void>)

Type declaration

    • (content, options?): Promise<void>

    • Rewrites the complete content for this resource. If a resource does not exist it will be created.

      If a resource supports versioning clients can pass some version to check against it, if it is not provided latest version is used.

      It updates version and encoding to latest.

      Parameters

      • content: string
      • Optional options: ResourceSaveOptions

      Returns Promise<void>

      Throws

      ResourceError.OutOfSync if latest resource version is out of sync with the given

Optional saveStream

saveStream?: ((content, options?) => Promise<void>)

Type declaration

    • (content, options?): Promise<void>

    • Rewrites the complete content for this resource. If a resource does not exist it will be created.

      If a resource supports versioning clients can pass some version to check against it, if it is not provided latest version is used.

      It updates version and encoding to latest.

      Parameters

      • content: Readable<string>
      • Optional options: ResourceSaveOptions

      Returns Promise<void>

      Throws

      ResourceError.OutOfSync if latest resource version is out of sync with the given

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Readonly uri

uri: URI

Protected writingLock

writingLock: Mutex = ...

Accessors

encoding

readOnly

version

Methods

dispose

Protected doWrite

guessEncoding

Protected isInSync

readContents

readStream

  • readStream(options?): Promise<ReadableStream<string>>

  • Parameters

    • Optional options: {
          encoding?: string;
      }
      • Optional encoding?: string

    Returns Promise<ReadableStream<string>>

Protected shouldOpenAsText

Protected shouldOverwrite

Protected sync

Protected updateReadOnly

Protected updateSavingContentChanges

Settings

Member Visibility

Theme

On This Page

constructor_versionacceptTextOnlydoSaveContentChangesfileServicelimitsonDidChangeContentsonDidChangeContentsEmitteronDidChangeReadOnlyonDidChangeReadOnlyEmitteroptionssaveContentChangessaveContentssaveStreamtoDisposeuriwritingLockencodingreadOnlyversiondisposedoWriteguessEncodingisInSyncreadContentsreadStreamshouldOpenAsTextshouldOverwritesyncupdateReadOnlyupdateSavingContentChanges