CSVAsyncTask

Inherits: RefCounted < Object

Asynchronous CSV and DSV load/save task.

Description

CSVAsyncTask runs CSV or DSV load/save work on a background thread. Use the static constructors to configure a task, call start(), then poll state or wait with wait_to_finish(). Load tasks expose rows with get_rows() and get_table().

Methods

void	cancel()
String	get_error() const
float	get_progress() const
Array	get_rows() const
CSVTable	get_table() const
bool	is_cancelled() const
bool	is_done() const
bool	is_running() const
CSVAsyncTask	load_csv(path: String, delimiter: String = ",", headers: bool = false, cast_fields: bool = true, options: Dictionary = {}) static
CSVAsyncTask	load_dsv(path: String, delimiter: String = ",", options: Dictionary = {}) static
CSVAsyncTask	save_csv(path: String, rows: Array, delimiter: String = ",", headers: bool = false, options: Dictionary = {}) static
CSVAsyncTask	save_dsv(path: String, rows: Array, delimiter: String = ",") static
Error	start()
void	wait_to_finish()

---

Signals

cancelled() 🔗

Emitted when the task finishes due to cancellation.

---

completed() 🔗

Emitted when the task finishes successfully.

---

failed(error: String) 🔗

Emitted when the task fails.

---

progress_changed(progress: float) 🔗

Emitted when task progress changes.

---

Method Descriptions

void cancel() 🔗

Requests cancellation. The task stops between row operations.

---

String get_error() const 🔗

Returns the task error message, or an empty string when no error occurred.

---

float get_progress() const 🔗

Returns progress in the range 0.0 to 1.0.

---

Array get_rows() const 🔗

Returns loaded rows for load tasks. Save tasks return an empty array.

---

CSVTable get_table() const 🔗

Returns loaded rows wrapped in a CSVTable.

---

bool is_cancelled() const 🔗

Returns true if the task finished due to cancellation.

---

bool is_done() const 🔗

Returns true when the task has finished, failed, or been cancelled.

---

bool is_running() const 🔗

Returns true while the background thread is active.

---

CSVAsyncTask load_csv(path: String, delimiter: String = ",", headers: bool = false, cast_fields: bool = true, options: Dictionary = {}) static 🔗

Creates a task that loads typed CSV rows from path.

---

CSVAsyncTask load_dsv(path: String, delimiter: String = ",", options: Dictionary = {}) static 🔗

Creates a task that loads raw DSV rows from path.

---

CSVAsyncTask save_csv(path: String, rows: Array, delimiter: String = ",", headers: bool = false, options: Dictionary = {}) static 🔗

Creates a task that saves CSV rows to path. options may include header_names, color_as_hex, and hex_include_alpha.

---

CSVAsyncTask save_dsv(path: String, rows: Array, delimiter: String = ",") static 🔗

Creates a task that saves raw DSV rows to path.

---

Error start() 🔗

Starts the background task.

---

void wait_to_finish() 🔗

Blocks until the background thread finishes. This is useful for tests or command-line workflows.