TarReader.GetNextEntryAsync(Boolean, CancellationToken) 方法

定义

命名空间:

System.Formats.Tar

程序集:

System.Formats.Tar.dll

Source:

TarReader.cs

从存档流中异步检索下一个条目。

public System.Threading.Tasks.ValueTask<System.Formats.Tar.TarEntry?> GetNextEntryAsync (bool copyData = false, System.Threading.CancellationToken cancellationToken = default);

member this.GetNextEntryAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Formats.Tar.TarEntry>

Public Function GetNextEntryAsync (Optional copyData As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TarEntry)

参数

copyData

Boolean

true 将条目的数据复制到新的 MemoryStream中。 当基础存档流不支持查找并且稍后需要访问数据时，这非常有用。

false 如果不应将数据复制到新流中，则为 。 如果基础流不支持查找，则用户负责在调用此方法后立即读取和处理 DataStream 。

默认值为 false。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

ValueTask<TarEntry>

如果找到有效条目或null已到达存档的末尾，则包含TarEntry实例的值任务。

例外

InvalidDataException

存档格式不正确。

-或-

存档包含不同格式的条目。

-或-

在当前 Pax 存档中发现了多个全局扩展属性条目。

-或-

在当前 Pax 存档中连续找到两个或更多扩展属性条目。

IOException

发生了 I/O 问题。

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

此方法存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 GetNextEntry(Boolean)异常。