CapyKit/Docs/_site/api/CapyKit.html

184 lines
6.7 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace CapyKit | CapyKit Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace CapyKit | CapyKit Documentation ">
<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="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="CapyKit Documentation">
CapyKit Documentation
</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="content">
<div class="actionbar">
<nav id="breadcrumb"></nav>
</div>
<article data-uid="CapyKit">
<h1 id="CapyKit" data-uid="CapyKit" class="text-break">Namespace CapyKit</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></dt>
<dd><p>The CapyEventArgs class represents an event argument instance with event level, message, and
method name information.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></dt>
<dd><p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.Color.html">Color</a></dt>
<dd><p>An object representing a color.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.EncryptedValue-1.html">EncryptedValue&lt;T&gt;</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
<dd><p>Represents a password with its hash, salt and algorithm used for encryption.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></dt>
<dd><p>Implements the PBKDF2 algorithm for password encryption.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.PoolItem-1.html">PoolItem&lt;T&gt;</a></dt>
<dd><p>A pool item. This class cannot be inherited.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.Pool-1.html">Pool&lt;T&gt;</a></dt>
<dd><p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
objects of type <code class="typeparamref">T</code>.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.PropertyComparer-2.html">PropertyComparer&lt;T, U&gt;</a></dt>
<dd><p>A object comparer that can accept a lambda expression to compare properties.</p>
</dd>
</dl>
<h3 id="interfaces">
Interfaces
</h3>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
<dd><p>Defines the contract for password encryption algorithms.</p>
</dd>
</dl>
<h3 id="enums">
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
<dd><p>Enumeration representing different event level severity values.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.NamedColor.html">NamedColor</a></dt>
<dd><p>Enum representing a set of named colors with their corresponding HEX values. These colors are
inspired by the XKCD color palette (<a href="https://xkcd.com/color/rgb/" target="_blank">Link</a>).</p>
</dd>
</dl>
<h3 id="delegates">
Delegates
</h3>
<dl class="jumplist">
<dt><a class="xref" href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></dt>
<dd><p>A delegate representing an event handler that accepts a <a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a> instance.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>