Zero Install .NET API 2.20.0
ZeroInstall.Archives.BuilderExtensions Class Reference

Helpers for adding Archives to IBuilders. More...

Static Public Member Functions

static void Add (this IBuilder builder, DownloadRetrievalMethod retrievalMethod, Stream stream, ITaskHandler handler, object? tag=null)
 Adds a downloaded file to the implementation. More...
 
static void AddArchive (this IBuilder builder, Archive archive, Stream stream, ITaskHandler handler, object? tag=null)
 Adds an archive to the implementation. More...
 

Detailed Description

Helpers for adding Archives to IBuilders.

Member Function Documentation

◆ Add()

static void ZeroInstall.Archives.BuilderExtensions.Add ( this IBuilder  builder,
DownloadRetrievalMethod  retrievalMethod,
Stream  stream,
ITaskHandler  handler,
object?  tag = null 
)
inlinestatic

Adds a downloaded file to the implementation.

Parameters
builderThe builder.
retrievalMethodThe metadata of the file.
streamThe contents of the file.
handlerA callback object used when the the user needs to be informed about IO tasks.
tagA ITask.Tag used to group progress bars. Usually ManifestDigest.Best.
Exceptions
UnauthorizedAccessExceptionAccess to a resource was denied.
IOExceptionAn IO operation failed.

◆ AddArchive()

static void ZeroInstall.Archives.BuilderExtensions.AddArchive ( this IBuilder  builder,
Archive  archive,
Stream  stream,
ITaskHandler  handler,
object?  tag = null 
)
inlinestatic

Adds an archive to the implementation.

Parameters
builderThe builder.
archiveThe metadata of the archive.
streamThe archive data to be extracted.
handlerA callback object used when the the user needs to be informed about IO tasks.
tagA ITask.Tag used to group progress bars. Usually ManifestDigest.Best.
Exceptions
OperationCanceledExceptionThe operation was canceled.
IOExceptionA problem occurred while extracting the archive.

The documentation for this class was generated from the following file: