Skip to content

Commit

Permalink
deploy: ba82ce3
Browse files Browse the repository at this point in the history
  • Loading branch information
@bastianeicher
bastianeicher committed Jul 18, 2024
0 parents commit abc5e37
Show file tree
Hide file tree
Showing 641 changed files with 275,261 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dotnet.0install.net
289 changes: 289 additions & 0 deletions api/ZeroInstall.Archives.BuilderExtensions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class BuilderExtensions | Zero Install .NET API </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BuilderExtensions | Zero Install .NET API ">

<meta name="description" content="Helpers for adding s to s.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/0install/0install-dotnet/new/master/apiSpec/new?filename=ZeroInstall_Archives_BuilderExtensions.md&amp;value=---%0Auid%3A%20ZeroInstall.Archives.BuilderExtensions%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

</head>

<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="ZeroInstall.Archives.BuilderExtensions">



<h1 id="ZeroInstall_Archives_BuilderExtensions" data-uid="ZeroInstall.Archives.BuilderExtensions" class="text-break">
Class BuilderExtensions <a class="header-action link-secondary" title="View source" href="https://github.com/0install/0install-dotnet/blob/master/src/Archives/BuilderExtensions.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="ZeroInstall.html">ZeroInstall</a>.<a class="xref" href="ZeroInstall.Archives.html">Archives</a></dd></dl>
<dl><dt>Assembly</dt><dd>ZeroInstall.Archives.dll</dd></dl>
</div>

<div class="markdown summary"><p>Helpers for adding <a class="xref" href="ZeroInstall.Model.Archive.html">Archive</a>s to <a class="xref" href="ZeroInstall.Store.FileSystem.IBuilder.html">IBuilder</a>s.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class BuilderExtensions</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">BuilderExtensions</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>






<h2 class="section" id="methods">Methods
</h2>


<a id="ZeroInstall_Archives_BuilderExtensions_Add_" data-uid="ZeroInstall.Archives.BuilderExtensions.Add*"></a>

<h3 id="ZeroInstall_Archives_BuilderExtensions_Add_ZeroInstall_Store_FileSystem_IBuilder_ZeroInstall_Model_DownloadRetrievalMethod_System_IO_Stream_NanoByte_Common_Tasks_ITaskHandler_System_Object_" data-uid="ZeroInstall.Archives.BuilderExtensions.Add(ZeroInstall.Store.FileSystem.IBuilder,ZeroInstall.Model.DownloadRetrievalMethod,System.IO.Stream,NanoByte.Common.Tasks.ITaskHandler,System.Object)">
Add(IBuilder, DownloadRetrievalMethod, Stream, ITaskHandler, object?)
<a class="header-action link-secondary" title="View source" href="https://github.com/0install/0install-dotnet/blob/master/src/Archives/BuilderExtensions.cs/#L24"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds a downloaded file to the implementation.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Add(this IBuilder builder, DownloadRetrievalMethod retrievalMethod, Stream stream, ITaskHandler handler, object? tag = null)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>builder</code> <a class="xref" href="ZeroInstall.Store.FileSystem.IBuilder.html">IBuilder</a></dt>
<dd><p>The builder.</p>
</dd>
<dt><code>retrievalMethod</code> <a class="xref" href="ZeroInstall.Model.DownloadRetrievalMethod.html">DownloadRetrievalMethod</a></dt>
<dd><p>The metadata of the file.</p>
</dd>
<dt><code>stream</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></dt>
<dd><p>The contents of the file.</p>
</dd>
<dt><code>handler</code> <a class="xref" href="https://common.nano-byte.net/api/NanoByte.Common.Tasks.ITaskHandler.html">ITaskHandler</a></dt>
<dd><p>A callback object used when the user needs to be informed about IO tasks.</p>
</dd>
<dt><code>tag</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>A <a class="xref" href="https://common.nano-byte.net/api/NanoByte.Common.Tasks.ITask.html#NanoByte_Common_Tasks_ITask_Tag">Tag</a> used to group progress bars. Usually <a class="xref" href="ZeroInstall.Model.ManifestDigest.html#ZeroInstall_Model_ManifestDigest_Best">Best</a>.</p>
</dd>
</dl>









<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.unauthorizedaccessexception">UnauthorizedAccessException</a></dt>
<dd><p>Access to a resource was denied.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.ioexception">IOException</a></dt>
<dd><p>An IO operation failed.</p>
</dd>
</dl>



<a id="ZeroInstall_Archives_BuilderExtensions_AddArchive_" data-uid="ZeroInstall.Archives.BuilderExtensions.AddArchive*"></a>

<h3 id="ZeroInstall_Archives_BuilderExtensions_AddArchive_ZeroInstall_Store_FileSystem_IBuilder_ZeroInstall_Model_Archive_System_IO_Stream_NanoByte_Common_Tasks_ITaskHandler_System_Object_" data-uid="ZeroInstall.Archives.BuilderExtensions.AddArchive(ZeroInstall.Store.FileSystem.IBuilder,ZeroInstall.Model.Archive,System.IO.Stream,NanoByte.Common.Tasks.ITaskHandler,System.Object)">
AddArchive(IBuilder, Archive, Stream, ITaskHandler, object?)
<a class="header-action link-secondary" title="View source" href="https://github.com/0install/0install-dotnet/blob/master/src/Archives/BuilderExtensions.cs/#L49"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Adds an archive to the implementation.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void AddArchive(this IBuilder builder, Archive archive, Stream stream, ITaskHandler handler, object? tag = null)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>builder</code> <a class="xref" href="ZeroInstall.Store.FileSystem.IBuilder.html">IBuilder</a></dt>
<dd><p>The builder.</p>
</dd>
<dt><code>archive</code> <a class="xref" href="ZeroInstall.Model.Archive.html">Archive</a></dt>
<dd><p>The metadata of the archive.</p>
</dd>
<dt><code>stream</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></dt>
<dd><p>The archive data to be extracted.</p>
</dd>
<dt><code>handler</code> <a class="xref" href="https://common.nano-byte.net/api/NanoByte.Common.Tasks.ITaskHandler.html">ITaskHandler</a></dt>
<dd><p>A callback object used when the user needs to be informed about IO tasks.</p>
</dd>
<dt><code>tag</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>A <a class="xref" href="https://common.nano-byte.net/api/NanoByte.Common.Tasks.ITask.html#NanoByte_Common_Tasks_ITask_Tag">Tag</a> used to group progress bars. Usually <a class="xref" href="ZeroInstall.Model.ManifestDigest.html#ZeroInstall_Model_ManifestDigest_Best">Best</a>.</p>
</dd>
</dl>









<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.operationcanceledexception">OperationCanceledException</a></dt>
<dd><p>The operation was canceled.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.ioexception">IOException</a></dt>
<dd><p>A problem occurred while extracting the archive.</p>
</dd>
</dl>




</article>

<div class="contribution d-print-none">
<a href="https://github.com/0install/0install-dotnet/blob/master/src/Archives/BuilderExtensions.cs/#L12" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
Copyright Bastian Eicher et al
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit abc5e37

Please sign in to comment.