Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

ReadHandle

struct in Unity.IO.LowLevel.Unsafe

/

Implemented in:UnityEngine.CoreModule

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

You can use this handle to query the status of an asynchronous read operation. Note: To avoid a memory leak, you must call Dispose.

Properties

JobHandleJobHandle that completes when the read operation completes.
ReadCountThe number of read commands performed for this read operation. Will return zero until the reads have begun.
StatusCurrent state of the read operation.

Public Methods

CancelCancels the AsyncReadManager.Read operation on this handle.
DisposeDisposes the ReadHandle. Use this to free up internal resources for reuse.
GetBytesReadReturns the total number of bytes read by all the ReadCommand operations the asynchronous file read request.
GetBytesReadArrayReturns an array containing the number of bytes read by the ReadCommand operations during the asynchronous file read request, where each index corresponds to the ReadCommand index.
IsValidCheck if the ReadHandle is valid.