Version: 2021.3
LanguageEnglish
  • C#

ReadStatus

enumeration

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The state of an asynchronous file request.

These enumerations represent the raw underlying states of an asynchronous file request.

When submitted, all requests enter the ReadStatus.InProgress state while they are pending execution or in progress. On completion, the state changes to ReadStatus.Complete, ReadStatus.Truncated or ReadStatus.Failed. If the read is canceled before completion, the state becomes ReadStatus.Canceled.

A truncated read occurs when attempting to access beyond the end of a file.

Properties

CompleteThe asynchronous file request completed successfully and all read operations within it were completed in full.
InProgressThe asynchronous file request is in progress.
FailedOne or more of the asynchronous file request's read operations have failed.
TruncatedThe asynchronous file request has completed but one or more of the read operations were truncated.
CanceledThe asynchronous file request was canceled before the read operations were completed.