Class FileResource

Implements

Resource

Constructors

constructor

new FileResource(
    uri: URI,
    fileService: FileService,
    options: FileResourceOptions,
): FileResource
Parameters
- uri: URI
- fileService: FileService
- options: FileResourceOptions
Returns FileResource
- Defined in packages/filesystem/src/browser/file-resource.ts:75

Properties

`Protected`_version

_version: undefined | FileResourceVersion

`Protected`acceptTextOnly

acceptTextOnly: boolean = true

`Protected`doSaveContentChanges

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

Type Declaration

undefined
(
changes: TextDocumentContentChangeEvent[],
options?: ResourceSaveOptions,
) => Promise<void>
- - (
    changes: TextDocumentContentChangeEvent[],
    options?: ResourceSaveOptions,
    ): 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[]
    - Optionaloptions: 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 }

`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: TextDocumentContentChangeEvent[],
options?: ResourceSaveOptions,
) => 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.

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: string, options?: ResourceSaveOptions) => 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.

Throws

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

`Optional`saveStream

saveStream?: (
content: Readable<string>,
options?: ResourceSaveOptions,
) => 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.

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

get encoding(): undefined | string
Latest read encoding of this resource.

Optional if a resource does not support encoding, check with in operator`. Undefined if a resource did not read content yet.

Returns undefined | string
Implementation of Resource.encoding
- Defined in packages/filesystem/src/browser/file-resource.ts:66

readOnly

get readOnly(): boolean | MarkdownString
Returns boolean | MarkdownString
Implementation of Resource.readOnly
- Defined in packages/filesystem/src/browser/file-resource.ts:69

version

get version(): undefined | FileResourceVersion
Latest read version of this resource.

Optional if a resource does not support versioning, check with in operator`. Undefined if a resource did not read content yet.

Returns undefined | FileResourceVersion
Implementation of Resource.version
- Defined in packages/filesystem/src/browser/file-resource.ts:63

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Resource.dispose
- Defined in packages/filesystem/src/browser/file-resource.ts:124

`Protected`doWrite

doWrite(
content: string | Readable<string>,
options?: ResourceSaveOptions,
): Promise<void>
Parameters
- content: string | Readable<string>
- Optionaloptions: ResourceSaveOptions
Returns Promise<void>
- Defined in packages/filesystem/src/browser/file-resource.ts:218

guessEncoding

guessEncoding(): Promise<string>
Returns Promise<string>
Implementation of Resource.guessEncoding
- Defined in packages/filesystem/src/browser/file-resource.ts:303

`Protected`isInSync

isInSync(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/filesystem/src/browser/file-resource.ts:315

readContents

readContents(options?: { encoding?: string }): Promise<string>
Reads latest content of this resource.

If a resource supports versioning it updates version to latest. If a resource supports encoding it updates encoding to latest.
Parameters
- Optionaloptions: { encoding?: string }
Returns Promise<string>
Throws
ResourceError.NotFound if a resource not found
Implementation of Resource.readContents
- Defined in packages/filesystem/src/browser/file-resource.ts:128

readStream

readStream(options?: { encoding?: string }): Promise<ReadableStream<string>>
Stream latest content of this resource.

If a resource supports versioning it updates version to latest. If a resource supports encoding it updates encoding to latest.
Parameters
- Optionaloptions: { encoding?: string }
Returns Promise<ReadableStream<string>>
Throws
ResourceError.NotFound if a resource not found
Implementation of Resource.readStream
- Defined in packages/filesystem/src/browser/file-resource.ts:173

`Protected`shouldOpenAsText

shouldOpenAsText(error: string): Promise<boolean>
Parameters
- error: string
Returns Promise<boolean>
- Defined in packages/filesystem/src/browser/file-resource.ts:329

`Protected`shouldOverwrite

shouldOverwrite(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/filesystem/src/browser/file-resource.ts:325

`Protected`sync

sync(): Promise<void>
Returns Promise<void>
- Defined in packages/filesystem/src/browser/file-resource.ts:309

`Protected`updateReadOnly

updateReadOnly(): Promise<void>
Returns Promise<void>
- Defined in packages/filesystem/src/browser/file-resource.ts:110

`Protected`updateSavingContentChanges

updateSavingContentChanges(): void
Returns void
- Defined in packages/filesystem/src/browser/file-resource.ts:253

Class FileResource

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FileResource

Properties

Protected_version

ProtectedacceptTextOnly

ProtecteddoSaveContentChanges

Type Declaration

Parameters

Returns Promise<void>

Throws

Throws

Protected ReadonlyfileService

Protectedlimits

ReadonlyonDidChangeContents

Protected ReadonlyonDidChangeContentsEmitter

ReadonlyonDidChangeReadOnly

Protected ReadonlyonDidChangeReadOnlyEmitter

Protected Readonlyoptions

OptionalsaveContentChanges

Throws

Throws

OptionalsaveContents

Throws

OptionalsaveStream

Throws

Protected ReadonlytoDispose

Readonlyuri

ProtectedwritingLock

Accessors

encoding

Returns undefined | string

readOnly

Returns boolean | MarkdownString

version

Returns undefined | FileResourceVersion

Methods

dispose

Returns void

ProtecteddoWrite

Parameters

Returns Promise<void>

guessEncoding

Returns Promise<string>

ProtectedisInSync

Returns Promise<boolean>

readContents

Parameters

Returns Promise<string>

Throws

readStream

Parameters

Returns Promise<ReadableStream<string>>

Throws

ProtectedshouldOpenAsText

Parameters

Returns Promise<boolean>

ProtectedshouldOverwrite

Returns Promise<boolean>

Protectedsync

Returns Promise<void>

ProtectedupdateReadOnly

Returns Promise<void>

ProtectedupdateSavingContentChanges

Returns void

Settings

On This Page

`Protected`_version

`Protected`acceptTextOnly

`Protected`doSaveContentChanges

`Protected` `Readonly`fileService

`Protected`limits

`Readonly`onDidChangeContents

`Protected` `Readonly`onDidChangeContentsEmitter

`Readonly`onDidChangeReadOnly

`Protected` `Readonly`onDidChangeReadOnlyEmitter

`Protected` `Readonly`options

`Optional`saveContentChanges

`Optional`saveContents

`Optional`saveStream

`Protected` `Readonly`toDispose

`Readonly`uri

`Protected`writingLock

`Protected`doWrite

`Protected`isInSync

`Protected`shouldOpenAsText

`Protected`shouldOverwrite

`Protected`sync

`Protected`updateReadOnly

`Protected`updateSavingContentChanges