FileHandle

Defined in: plugins/fs/guest-js/index.ts:282

The Tauri abstraction for reading and writing files.

Constructors

Constructor

new FileHandle(rid): FileHandle

Defined in: node_modules/.pnpm/@tauri-apps+api@2.7.0/node_modules/@tauri-apps/api/core.d.ts:184

Accessors

rid

Get Signature

get rid(): number

Defined in: node_modules/.pnpm/@tauri-apps+api@2.7.0/node_modules/@tauri-apps/api/core.d.ts:183

Methods

close()

close(): Promise<void>

Defined in: node_modules/.pnpm/@tauri-apps+api@2.7.0/node_modules/@tauri-apps/api/core.d.ts:189

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

read()

read(buffer): Promise<null | number>

Defined in: plugins/fs/guest-js/index.ts:314

Reads up to p.byteLength bytes into p. It resolves to the number of bytes read (0 < n <= p.byteLength) and rejects if any error encountered. Even if read() resolves to n < p.byteLength, it may use all of p as scratch space during the call. If some data is available but not p.byteLength bytes, read() conventionally resolves to what is available instead of waiting for more.

When read() encounters end-of-file condition, it resolves to EOF (null).

When read() encounters an error, it rejects with an error.

Callers should always process the n > 0 bytes returned before considering the EOF (null). Doing so correctly handles I/O errors that happen after reading some bytes and also both of the allowed EOF behaviors.

Parameters

buffer

Uint8Array

Returns

Promise<null | number>

Example

import { open, BaseDirectory } from "@tauri-apps/plugin-fs"
// if "$APPCONFIG/foo/bar.txt" contains the text "hello world":
const file = await open("foo/bar.txt", { baseDir: BaseDirectory.AppConfig });
const buf = new Uint8Array(100);
const numberOfBytesRead = await file.read(buf); // 11 bytes
const text = new TextDecoder().decode(buf);  // "hello world"
await file.close();

Since

2.0.0

seek()

seek(offset, whence): Promise<number>

Defined in: plugins/fs/guest-js/index.ts:369

Seek sets the offset for the next read() or write() to offset, interpreted according to whence: Start means relative to the start of the file, Current means relative to the current offset, and End means relative to the end. Seek resolves to the new offset relative to the start of the file.

Seeking to an offset before the start of the file is an error. Seeking to any positive offset is legal, but the behavior of subsequent I/O operations on the underlying object is implementation-dependent. It returns the number of cursor position.

Parameters

offset

number

whence

SeekMode

Returns

Promise<number>

Example

import { open, SeekMode, BaseDirectory } from '@tauri-apps/plugin-fs';

// Given hello.txt pointing to file with "Hello world", which is 11 bytes long:
const file = await open('hello.txt', { read: true, write: true, truncate: true, create: true, baseDir: BaseDirectory.AppLocalData });
await file.write(new TextEncoder().encode("Hello world"));

// Seek 6 bytes from the start of the file
console.log(await file.seek(6, SeekMode.Start)); // "6"
// Seek 2 more bytes from the current position
console.log(await file.seek(2, SeekMode.Current)); // "8"
// Seek backwards 2 bytes from the end of the file
console.log(await file.seek(-2, SeekMode.End)); // "9" (e.g. 11-2)

await file.close();

Since

2.0.0

stat()

stat(): Promise<FileInfo>

Defined in: plugins/fs/guest-js/index.ts:391

Returns a FileInfo for this file.

Returns

Promise<FileInfo>

Example

import { open, BaseDirectory } from '@tauri-apps/plugin-fs';
const file = await open("file.txt", { read: true, baseDir: BaseDirectory.AppLocalData });
const fileInfo = await file.stat();
console.log(fileInfo.isFile); // true
await file.close();

Since

2.0.0

truncate()

truncate(len?): Promise<void>

Defined in: plugins/fs/guest-js/index.ts:423

Truncates or extends this file, to reach the specified len. If len is not specified then the entire file contents are truncated.

Parameters

len?

number

Returns

Promise<void>

Example

import { open, BaseDirectory } from '@tauri-apps/plugin-fs';

// truncate the entire file
const file = await open("my_file.txt", { read: true, write: true, create: true, baseDir: BaseDirectory.AppLocalData });
await file.truncate();

// truncate part of the file
const file = await open("my_file.txt", { read: true, write: true, create: true, baseDir: BaseDirectory.AppLocalData });
await file.write(new TextEncoder().encode("Hello World"));
await file.truncate(7);
const data = new Uint8Array(32);
await file.read(data);
console.log(new TextDecoder().decode(data)); // Hello W
await file.close();

Since

2.0.0

write()

write(data): Promise<number>

Defined in: plugins/fs/guest-js/index.ts:450

Writes data.byteLength bytes from data to the underlying data stream. It resolves to the number of bytes written from data (0 <= n <= data.byteLength) or reject with the error encountered that caused the write to stop early. write() must reject with a non-null error if would resolve to n < data.byteLength. write() must not modify the slice data, even temporarily.

import { open, write, BaseDirectory } from '@tauri-apps/plugin-fs';
const encoder = new TextEncoder();
const data = encoder.encode("Hello world");
const file = await open("bar.txt", { write: true, baseDir: BaseDirectory.AppLocalData });
const bytesWritten = await file.write(data); // 11
await file.close();

Since

2.0.0