Improve DocFX documentation generation
This commit is contained in:
parent
85e90f7bd5
commit
9ce4e18637
316 changed files with 476 additions and 23671 deletions
13
.config/dotnet-tools.json
Normal file
13
.config/dotnet-tools.json
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
{
|
||||
"version": 1,
|
||||
"isRoot": true,
|
||||
"tools": {
|
||||
"docfx": {
|
||||
"version": "2.78.5",
|
||||
"commands": [
|
||||
"docfx"
|
||||
],
|
||||
"rollForward": false
|
||||
}
|
||||
}
|
||||
}
|
||||
6
.gitignore
vendored
6
.gitignore
vendored
|
|
@ -32,6 +32,12 @@ bld/
|
|||
[Ll]og/
|
||||
[Ll]ogs/
|
||||
|
||||
# DocFX generated output
|
||||
Docs/_site/
|
||||
Docs/api/.manifest
|
||||
Docs/api/*.yml
|
||||
Docs/api/toc.yml
|
||||
|
||||
# Visual Studio 2015/2017 cache/options directory
|
||||
.vs/
|
||||
# Uncomment if you have tasks that create the project's static files in wwwroot
|
||||
|
|
|
|||
|
|
@ -1,179 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class EnumerationAttribute<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class EnumerationAttribute<T> | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Attributes_EnumerationAttribute_1"> Class EnumerationAttribute<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Field)]
|
||||
public abstract class EnumerationAttribute<T> : Attribute
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter allowing for arbitrary declarations and assignments of meaning.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EnumerationAttribute<T>>(EnumerationAttribute<T>, EnumerationAttribute<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Attributes_EnumerationAttribute_1__ctor__0_"> EnumerationAttribute(T)</h3>
|
||||
<p>Gets the value of the enumeration represented by this attribute.</p>
|
||||
<pre><code class="lang-csharp">protected EnumerationAttribute(T value)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>value</code> T</p>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationAttribute`1</span> class with a
|
||||
specified value.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Attributes_EnumerationAttribute_1_Value"> Value</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationAttribute`1</span> class with a
|
||||
specified value.</p>
|
||||
<pre><code class="lang-csharp">public T Value { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p>T</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,172 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class EnumerationDescriptionAttribute | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class EnumerationDescriptionAttribute | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Attributes_EnumerationDescriptionAttribute"> Class EnumerationDescriptionAttribute</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An attribute class for decorating enumeration fields with a description.</p>
|
||||
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Field)]
|
||||
public class EnumerationDescriptionAttribute : EnumerationAttribute<string>
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<string></a> ←
|
||||
<a href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html#CapyKit_Attributes_EnumerationAttribute_1_Value">EnumerationAttribute<string>.Value</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EnumerationDescriptionAttribute>(EnumerationDescriptionAttribute, EnumerationDescriptionAttribute)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_System_String_"> EnumerationDescriptionAttribute(string)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationDescriptionAttribute</span> class with
|
||||
the specified description.</p>
|
||||
<pre><code class="lang-csharp">public EnumerationDescriptionAttribute(string description)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>description</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The description of the enumeration value.</p>
|
||||
<h2 id="see-also">See Also</h2>
|
||||
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute</a><T></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,191 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class ValueFormatAttribute | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class ValueFormatAttribute | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Attributes_ValueFormatAttribute"> Class ValueFormatAttribute</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Custom attribute for formatting values in a specific way.</p>
|
||||
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Property)]
|
||||
public class ValueFormatAttribute : Attribute
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||
<a href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<ValueFormatAttribute>(ValueFormatAttribute, ValueFormatAttribute)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor"> ValueFormatAttribute()</h3>
|
||||
<p>Default constructor. Initializes a new instance of the <span class="xref">CapyKit.Attributes.ValueFormatAttribute</span>
|
||||
class with an empty format string.</p>
|
||||
<pre><code class="lang-csharp">public ValueFormatAttribute()
|
||||
</code></pre>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor_System_String_"> ValueFormatAttribute(string)</h3>
|
||||
<p>Constructor. Initializes a new instance of the <span class="xref">CapyKit.Attributes.ValueFormatAttribute</span> class with
|
||||
the specified format string.</p>
|
||||
<pre><code class="lang-csharp">public ValueFormatAttribute(string format)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>format</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The format string used to format the value.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute_Format"> Format</h3>
|
||||
<p>Gets or sets the format to use for formatting the value.</p>
|
||||
<pre><code class="lang-csharp">public string Format { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString_System_Int32_"> GetFormatParameterizedString(int)</h3>
|
||||
<p>Gets a parameterized formatted string for the specified index.</p>
|
||||
<pre><code class="lang-csharp">public string GetFormatParameterizedString(int index = 0)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>index</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>(Optional) Zero-based index of the item in the string to format.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A formatted string with the specified index and format.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,108 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Namespace CapyKit.Attributes | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Namespace CapyKit.Attributes | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Attributes"> Namespace CapyKit.Attributes</h1>
|
||||
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a></p>
|
||||
<p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||
<p><a href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></p>
|
||||
<p>An attribute class for decorating enumeration fields with a description.</p>
|
||||
<p><a href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a></p>
|
||||
<p>Custom attribute for formatting values in a specific way.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,154 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class CapyEventArgs | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class CapyEventArgs | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_CapyEventArgs"> Class CapyEventArgs</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
method name information.</p>
|
||||
<pre><code class="lang-csharp">public class CapyEventArgs : EventArgs
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a> ←
|
||||
<a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.eventargs.empty">EventArgs.Empty</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_"> CapyEventArgs(EventLevel, string, string)</h3>
|
||||
<p>Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.</p>
|
||||
<pre><code class="lang-csharp">public CapyEventArgs(EventLevel level, string message, string method = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>level</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A descriptive message explaining the reason for the event.</p>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the method where the event was raised.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_CapyEventArgs_Level"> Level</h3>
|
||||
<p>Gets the severity level of the event.</p>
|
||||
<pre><code class="lang-csharp">public EventLevel Level { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<h3 id="CapyKit_CapyEventArgs_Message"> Message</h3>
|
||||
<p>Gets the message describing the reason for the event.</p>
|
||||
<pre><code class="lang-csharp">public string Message { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h3 id="CapyKit_CapyEventArgs_MethodName"> MethodName</h3>
|
||||
<p>Gets the name of the method where the event was raised.</p>
|
||||
<pre><code class="lang-csharp">public string MethodName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,112 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Delegate CapyEventHandler | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Delegate CapyEventHandler | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_CapyEventHandler"> Delegate CapyEventHandler</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A delegate representing an event handler that accepts a <span class="xref">CapyKit.CapyEventArgs</span> instance.</p>
|
||||
<pre><code class="lang-csharp">public delegate void CapyEventHandler(CapyEventArgs e)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>e</code> <a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<p>The CapyEventArgs instance containing event data.</p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<CapyEventHandler>(CapyEventHandler, CapyEventHandler)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,193 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class CapyEventReporter | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class CapyEventReporter | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_CapyEventReporter"> Class CapyEventReporter</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
<pre><code class="lang-csharp">public static class CapyEventReporter
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="remarks">Remarks</h2>
|
||||
<p>Because consumers of CapyKit may have varied ways of handling logging, the <span class="xref">CapyKit.CapyEventReporter</span> provides
|
||||
a way for subscribers to recieve events for various "events" within the library. These can be thought of as
|
||||
a logging solution for CapyKit. Consumers are free to treat these events however they see fit.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___"> EmitEvent(EventLevel, string, string, params object[])</h3>
|
||||
<p>Emits an event with the given severity level, message, and method name.</p>
|
||||
<pre><code class="lang-csharp">public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>eventLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||
is accepted.</p>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>(Optional) The name of the method where the event was raised.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||
<h4 id="examples">Examples</h4>
|
||||
<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>In order to allow for efficient calling member access via <span class="xref">System.Runtime.CompilerServices.CallerMemberNameAttribute</span>
|
||||
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a></p>
|
||||
<h3 id="CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___"> EmitEventOnce(EventLevel, string, string, string, params object[])</h3>
|
||||
<p>Emits an event with the given severity level, message, unique identifier, and method name one
|
||||
time.</p>
|
||||
<pre><code class="lang-csharp">public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>eventLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||
is accepted.</p>
|
||||
<p><code>uniqueIdentifier</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A unique identifier for the event emission.</p>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>(Optional) The name of the method where the event was raised.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>This method is similar to EmitEvent(EventLevel, string, string, string, object[])
|
||||
, but requires a unique identifier (such as a <span class="xref">System.Guid</span>) to prevent duplicate
|
||||
emissions.</p>
|
||||
<h4 id="see-also-1">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></p>
|
||||
<h3 id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_"> Subscribe(CapyEventHandler, EventLevel, string)</h3>
|
||||
<p>Subscribes the specified event handler to the event with the given subscription level and
|
||||
origin.</p>
|
||||
<pre><code class="lang-csharp">public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>callback</code> <a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>The event handler to subscribe.</p>
|
||||
<p><code>subscriptionLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event to subscribe to.</p>
|
||||
<p><code>origin</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>(Optional) The name of the method or class where the subscription is made.</p>
|
||||
<h4 id="remarks-3">Remarks</h4>
|
||||
<p>If there is no existing list for the given subscription level, a new list is created and
|
||||
added to the dictionary.</p>
|
||||
<h3 id="CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_"> Unsubscribe(CapyEventHandler, string)</h3>
|
||||
<p>Unsubscribes the specified event handler from the event with the given origin.</p>
|
||||
<pre><code class="lang-csharp">public static void Unsubscribe(CapyEventHandler callback, string origin)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>callback</code> <a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>The event handler to unsubscribe.</p>
|
||||
<p><code>origin</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the method or class where the subscription was made.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,120 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class Color | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class Color | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Color"> Class Color</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An object representing a color.</p>
|
||||
<pre><code class="lang-csharp">public class Color
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Color.html">Color</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Color>(Color, Color)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,127 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class EncryptedValue<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class EncryptedValue<T> | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_EncryptedValue_1"> Class EncryptedValue<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public class EncryptedValue<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EncryptedValue<T>>(EncryptedValue<T>, EncryptedValue<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_EncryptedValue_1_Value"> Value</h3>
|
||||
<pre><code class="lang-csharp">public T Value { get; set; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p>T</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,120 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Enum MeasurementSystem | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Enum MeasurementSystem | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Enumerations_MeasurementSystem"> Enum MeasurementSystem</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Enumerations.html">CapyKit.Enumerations</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An enumeration representing different measurement systems.</p>
|
||||
<pre><code class="lang-csharp">public enum MeasurementSystem
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string, bool)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<MeasurementSystem>(MeasurementSystem, MeasurementSystem)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<p><code>Imperial = 0</code></p>
|
||||
<p>The imperial measurement system.</p>
|
||||
<p><code>Metric = 1</code></p>
|
||||
<p>The metric measurement system.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,104 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Namespace CapyKit.Enumerations | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Namespace CapyKit.Enumerations | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Enumerations"> Namespace CapyKit.Enumerations</h1>
|
||||
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>An enumeration representing different measurement systems.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,126 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Enum EventLevel | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Enum EventLevel | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_EventLevel"> Enum EventLevel</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Enumeration representing different event level severity values.</p>
|
||||
<pre><code class="lang-csharp">public enum EventLevel
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<EventLevel>(EventLevel, string)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<EventLevel>(EventLevel, string, bool)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EventLevel>(EventLevel, EventLevel)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<p><code>Critical = 0</code></p>
|
||||
<p>Represents a critical error that requires immediate attention.</p>
|
||||
<p><code>Debug = 4</code></p>
|
||||
<p>Represents detailed messages that are typically used for debugging purposes.</p>
|
||||
<p><code>Error = 1</code></p>
|
||||
<p>Represents an error that prevents the normal execution of the application.</p>
|
||||
<p><code>Information = 3</code></p>
|
||||
<p>Represents informational messages that provide useful context to the consumer.</p>
|
||||
<p><code>Warning = 2</code></p>
|
||||
<p>Represents a warning indicating a non-critical issue that should be addressed.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,192 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class EnumerationExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class EnumerationExtensions | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Extensions_EnumerationExtensions"> Class EnumerationExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.Enum</span> types.</p>
|
||||
<pre><code class="lang-csharp">public static class EnumerationExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_"> GetDescription(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a description.</p>
|
||||
<pre><code class="lang-csharp">public static string GetDescription(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The description if available, otherwise the string representation of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_"> GetName(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a name.</p>
|
||||
<pre><code class="lang-csharp">public static string GetName(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_"> GetPrettyName(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a human readable name.</p>
|
||||
<pre><code class="lang-csharp">public static string GetPrettyName(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The human readable name of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_"> GetValue(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets an integer value representing the enumation.</p>
|
||||
<pre><code class="lang-csharp">public static int GetValue(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The integer value of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_"> Parse<T>(T, string)</h3>
|
||||
<p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
<pre><code class="lang-csharp">public static T Parse<T>(this T enumeration, string value) where T : Enum
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>enumeration</code> T</p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The value.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A T.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_"> Parse<T>(T, string, bool)</h3>
|
||||
<p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
<pre><code class="lang-csharp">public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>enumeration</code> T</p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string value of the <span class="xref">System.Enum</span>.</p>
|
||||
<p><code>ignoreCase</code> <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True to ignore case.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A T.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,311 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class LINQExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class LINQExtensions | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Extensions_LINQExtensions"> Class LINQExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extension methods for performing common LINQ operations on <span class="xref">System.Collections.Generic.IEnumerable`1</span> and <span class="xref">System.Linq.IQueryable`1</span> collections.</p>
|
||||
<pre><code class="lang-csharp">public static class LINQExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.LINQExtensions.html">LINQExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Distinct__2_System_Collections_Generic_IEnumerable___0__System_Func___0___1__"> Distinct<T, U>(IEnumerable<T>, Func<T, U>)</h3>
|
||||
<p>Enumerates distinct items in this collection as defined by the key <code class="paramref">property</code>.</p>
|
||||
<pre><code class="lang-csharp">public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>items</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The items to act on.</p>
|
||||
<p><code>property</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>The property.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process distinct items in this collection.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter of the parent object.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter property value.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Collections_Generic_IEnumerable___0__System_Func___0_System_Boolean__"> Filter<T>(IEnumerable<T>, Func<T, bool>)</h3>
|
||||
<p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||
<pre><code class="lang-csharp">public static IEnumerable<T> Filter<T>(this IEnumerable<T> source, Func<T, bool> predicate)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>predicate</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></p>
|
||||
<p>The predicate.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Linq_IQueryable___0__System_Linq_Expressions_Expression_System_Func___0_System_Boolean___"> Filter<T>(IQueryable<T>, Expression<Func<T, bool>>)</h3>
|
||||
<p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||
<pre><code class="lang-csharp">public static IQueryable<T> Filter<T>(this IQueryable<T> source, Expression<Func<T, bool>> predicate)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>predicate</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>>></p>
|
||||
<p>The predicate.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_System_Linq_IQueryable___0__System_Linq_IQueryable___1__System_Linq_Expressions_Expression_System_Func___0___2___System_Linq_Expressions_Expression_System_Func___1___2___System_Func___0_System_Collections_Generic_IEnumerable___1____3__System_Func___0___1__"> LeftOuterJoin<T, U, TKey, R>(IQueryable<T>, IQueryable<U>, Expression<Func<T, TKey>>, Expression<Func<U, TKey>>, Func<T, IEnumerable<U>, R>, Func<T, U>)</h3>
|
||||
<p>An IQueryable<T> extension method that left outer join.</p>
|
||||
<pre><code class="lang-csharp">public static IQueryable<R> LeftOuterJoin<T, U, TKey, R>(this IQueryable<T> source, IQueryable<U> inner, Expression<Func<T, TKey>> outerSelector, Expression<Func<U, TKey>> innerSelector, Func<T, IEnumerable<U>, R> resultSelector, Func<T, U> defaultGenerator = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>inner</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><U></p>
|
||||
<p>The inner.</p>
|
||||
<p><code>outerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey>></p>
|
||||
<p>The outer selector.</p>
|
||||
<p><code>innerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><U, TKey>></p>
|
||||
<p>The inner selector.</p>
|
||||
<p><code>resultSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U>, R></p>
|
||||
<p>The result selector.</p>
|
||||
<p><code>defaultGenerator</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>(Optional) The default generator.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><R></p>
|
||||
<p>An IQueryable<R></p>
|
||||
<h4 id="type-parameters-3">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>TKey</code></p>
|
||||
<p>Type of the key.</p>
|
||||
<p><code>R</code></p>
|
||||
<p>Type of the r.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_System_Collections_Generic_IEnumerable___0__System_Collections_Generic_IEnumerable___1__System_Func___0___2__System_Func___1___2__System_Func___0_System_Collections_Generic_IEnumerable___1____3__System_Func___0___1__"> LeftOuterJoin<T, U, TKey, R>(IEnumerable<T>, IEnumerable<U>, Func<T, TKey>, Func<U, TKey>, Func<T, IEnumerable<U>, R>, Func<T, U>)</h3>
|
||||
<p>An IEnumable<T> extension method that left outer join.</p>
|
||||
<pre><code class="lang-csharp">public static IEnumerable<R> LeftOuterJoin<T, U, TKey, R>(this IEnumerable<T> source, IEnumerable<U> inner, Func<T, TKey> outerSelector, Func<U, TKey> innerSelector, Func<T, IEnumerable<U>, R> resultSelector, Func<T, U> defaultGenerator = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>inner</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U></p>
|
||||
<p>The inner.</p>
|
||||
<p><code>outerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey></p>
|
||||
<p>The outer selector.</p>
|
||||
<p><code>innerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><U, TKey></p>
|
||||
<p>The inner selector.</p>
|
||||
<p><code>resultSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U>, R></p>
|
||||
<p>The result selector.</p>
|
||||
<p><code>defaultGenerator</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>(Optional) The default generator.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><R></p>
|
||||
<p>An enumerator that allows foreach to be used to process left outter join in this collection.</p>
|
||||
<h4 id="type-parameters-4">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>TKey</code></p>
|
||||
<p>Type of the key.</p>
|
||||
<p><code>R</code></p>
|
||||
<p>Type of the r.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32_"> Page<T>(IEnumerable<T>, int, int)</h3>
|
||||
<p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||
<code class="paramref">pageSize</code> items per page.</p>
|
||||
<pre><code class="lang-csharp">public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageNumber</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The page number to retrieve.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>Number of items per page.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||
<h4 id="type-parameters-5">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method uses natural numbering starting at page 1.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
|
||||
<code class="paramref">pageSize</code> is less than
|
||||
<code>1</code>.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32_"> Page<T>(IQueryable<T>, int, int)</h3>
|
||||
<p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||
<code class="paramref">pageSize</code> items per page.</p>
|
||||
<pre><code class="lang-csharp">public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageNumber</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The page number to retrieve.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||
<h4 id="type-parameters-6">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>This method uses natural numbering starting at page 1.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
|
||||
<code class="paramref">pageSize</code> is less than
|
||||
<code>1</code>.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Collections_Generic_IEnumerable___0__System_Int32_"> PageCount<T>(IEnumerable<T>, int)</h3>
|
||||
<p>The number of pages of <code class="paramref">pageSize</code> size in the given collection.</p>
|
||||
<pre><code class="lang-csharp">public static int PageCount<T>(this IEnumerable<T> source, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>Size of the page.</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>An int.</p>
|
||||
<h4 id="type-parameters-7">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions-2">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Linq_IQueryable___0__System_Int32_"> PageCount<T>(IQueryable<T>, int)</h3>
|
||||
<p>The number of pages of <code class="paramref">pageSize</code> size in the given collection.</p>
|
||||
<pre><code class="lang-csharp">public static int PageCount<T>(this IQueryable<T> source, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-8">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>Size of the page.</p>
|
||||
<h4 id="returns-8">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>An int.</p>
|
||||
<h4 id="type-parameters-8">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions-3">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,143 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class ObjectExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class ObjectExtensions | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Extensions_ObjectExtensions"> Class ObjectExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An class containing extenstions that apply to any object type.</p>
|
||||
<pre><code class="lang-csharp">public static class ObjectExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html">ObjectExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_"> UpdateProperties<T>(T, T)</h3>
|
||||
<p>An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||
object with the values from a given <code class="paramref">source</code> object.</p>
|
||||
<pre><code class="lang-csharp">public static void UpdateProperties<T>(this T target, T source)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>target</code> T</p>
|
||||
<p>The target object to act on.</p>
|
||||
<p><code>source</code> T</p>
|
||||
<p>Source for the new property values.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_"> UpdateProperties(object, object)</h3>
|
||||
<p>An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||
object with the values from a given <code class="paramref">source</code> object.</p>
|
||||
<pre><code class="lang-csharp">public static void UpdateProperties(this object target, object source)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>target</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The target object to act on.</p>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>Source for the new property values.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,148 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class StringExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class StringExtensions | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Extensions_StringExtensions"> Class StringExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.String</span> types.</p>
|
||||
<pre><code class="lang-csharp">public static class StringExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.StringExtensions.html">StringExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_"> IfNullOrEmpty(string, string)</h3>
|
||||
<p>Replaces a null or empty string with a specified replacement string.</p>
|
||||
<pre><code class="lang-csharp">public static string IfNullOrEmpty(this string value, string replacement)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string.</p>
|
||||
<p><code>replacement</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The replacement string.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string if not null or empty, otherwise the replacement string.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorempty">IsNullOrEmpty</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>?)</p>
|
||||
<h3 id="CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_"> IfNullOrWhiteSpace(string, string)</h3>
|
||||
<p>Replaces a null or whitespace string with a specified replacement string.</p>
|
||||
<pre><code class="lang-csharp">public static string IfNullOrWhiteSpace(this string value, string replacement)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string.</p>
|
||||
<p><code>replacement</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The replacement string.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string if not null or whitespace, otherwise the replacement string.</p>
|
||||
<h4 id="see-also-1">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace">IsNullOrWhiteSpace</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>?)</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,110 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Namespace CapyKit.Extensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Namespace CapyKit.Extensions | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Extensions"> Namespace CapyKit.Extensions</h1>
|
||||
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</a></p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.Enum</span> types.</p>
|
||||
<p><a href="CapyKit.Extensions.LINQExtensions.html">LINQExtensions</a></p>
|
||||
<p>Provides static extension methods for performing common LINQ operations on <span class="xref">System.Collections.Generic.IEnumerable`1</span> and <span class="xref">System.Linq.IQueryable`1</span> collections.</p>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html">ObjectExtensions</a></p>
|
||||
<p>An class containing extenstions that apply to any object type.</p>
|
||||
<p><a href="CapyKit.Extensions.StringExtensions.html">StringExtensions</a></p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.String</span> types.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,240 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class CalculationHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class CalculationHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_CalculationHelper"> Class CalculationHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Static class providing helper methods for various calculations.</p>
|
||||
<pre><code class="lang-csharp">public static class CalculationHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS"> EARTH_RADIUS_KILOMETERS</h3>
|
||||
<p>The earth's radius in kilometers.</p>
|
||||
<pre><code class="lang-csharp">public const int EARTH_RADIUS_KILOMETERS = 6371
|
||||
</code></pre>
|
||||
<h4 id="field-value">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER"> MILES_PER_KILOMETER</h3>
|
||||
<p>Ratio of miles per kilometer .</p>
|
||||
<pre><code class="lang-csharp">public const double MILES_PER_KILOMETER = 0.621371
|
||||
</code></pre>
|
||||
<h4 id="field-value-1">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_"> CalculateHash(string)</h3>
|
||||
<p>Calculates the hash of a given string using an <span class="xref">System.Security.Cryptography.MD5</span> value as the first 32 bits.</p>
|
||||
<pre><code class="lang-csharp">public static int CalculateHash(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string to be hashed.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The calculated hash.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method is used for a quick and consistent hash function. It should not be considered
|
||||
cryptographically sound or used in security contexts.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_"> CalculateHexHash(string)</h3>
|
||||
<p>Calculates the hexadecimal hash.</p>
|
||||
<pre><code class="lang-csharp">public static string CalculateHexHash(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string to be hashed.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The calculated 16 character hexadecimal hash.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_"> DegreesToRadians(double)</h3>
|
||||
<p>Convers degrees to radians.</p>
|
||||
<pre><code class="lang-csharp">public static double DegreesToRadians(double degrees)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>degrees</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The degree value.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value as radians.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)</h3>
|
||||
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
<pre><code class="lang-csharp">public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The latitude origin.</p>
|
||||
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The longitude origin.</p>
|
||||
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The latitude destination.</p>
|
||||
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The longitude destination.</p>
|
||||
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>(Optional) The measurement system.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The distance.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a>.<a href="CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_">GetDistance</a>(<a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a>)</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(double, double, double, double, MeasurementSystem)</h3>
|
||||
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
<pre><code class="lang-csharp">public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The latitude of the origin.</p>
|
||||
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The longitude of the origin.</p>
|
||||
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The latitude destination.</p>
|
||||
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The longitude destination.</p>
|
||||
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>(Optional) The measurement system.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The distance.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_"> KilometersToMiles(double)</h3>
|
||||
<p>Converts kilometers to miles.</p>
|
||||
<pre><code class="lang-csharp">public static double KilometersToMiles(double kilometers)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>kilometers</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in kilometers.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in miles.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_"> MilesToKilometers(double)</h3>
|
||||
<p>Converts miles to kilometers.</p>
|
||||
<pre><code class="lang-csharp">public static double MilesToKilometers(double miles)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>miles</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in miles.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in kilometers.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_"> RadiansToDegrees(double)</h3>
|
||||
<p>Converts radians to degrees.</p>
|
||||
<pre><code class="lang-csharp">public static double RadiansToDegrees(double radians)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>radians</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The radian value.</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value as degrees.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,176 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class CompressionHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class CompressionHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_CompressionHelper"> Class CompressionHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing data compression.</p>
|
||||
<pre><code class="lang-csharp">public static class CompressionHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.CompressionHelper.html">CompressionHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Compress_System_Object_"> Compress(object)</h3>
|
||||
<p>Compresses a given object using the <code>gzip</code> algorithm.</p>
|
||||
<pre><code class="lang-csharp">public static byte[] Compress(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array representing the compressed object in <code>gzip</code> format.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_"> CompressToString(object)</h3>
|
||||
<p>Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.</p>
|
||||
<pre><code class="lang-csharp">public static string CompressToString(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string in <code>base64</code> encoding.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_"> Decompress<T>(string)</h3>
|
||||
<p>Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.</p>
|
||||
<pre><code class="lang-csharp">public static T Decompress<T>(string encodedString)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>encodedString</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The <code>base64</code> encoded <code>gzip</code> string.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> typed object.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_Byte___"> Decompress<T>(byte[])</h3>
|
||||
<p>Decompresses a given compressed <code>gzip</code> byte stream.</p>
|
||||
<pre><code class="lang-csharp">public static T Decompress<T>(byte[] byteStream)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>byteStream</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The compressed byte stream.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> typed object.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_"> DecompressToString(string)</h3>
|
||||
<p>Decompresses the given <code>base64</code> string in <code>gzip</code> format.</p>
|
||||
<pre><code class="lang-csharp">public static string DecompressToString(string compressed)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>compressed</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The compressed string.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A decomressed string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,125 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class EncryptionHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class EncryptionHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_EncryptionHelper"> Class EncryptionHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public class EncryptionHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.EncryptionHelper.html">EncryptionHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EncryptionHelper>(EncryptionHelper, EncryptionHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Helpers_EncryptionHelper__ctor_System_String_"> EncryptionHelper(string)</h3>
|
||||
<pre><code class="lang-csharp">public EncryptionHelper(string encryptionKey)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>encryptionKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,135 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Interface IEncryptionAlgorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Interface IEncryptionAlgorithm | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_IEncryptionAlgorithm"> Interface IEncryptionAlgorithm</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public interface IEncryptionAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___"> Decrypt<T>(EncryptedValue<T>, params object[])</h3>
|
||||
<pre><code class="lang-csharp">T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>encryptedValue</code> <a href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p>T</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___"> Encrypt<T>(object, params object[])</h3>
|
||||
<pre><code class="lang-csharp">EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,190 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class KeyHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class KeyHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_KeyHelper"> Class KeyHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
<pre><code class="lang-csharp">public class KeyHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<KeyHelper>(KeyHelper, KeyHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey"> GenerateKey()</h3>
|
||||
<p>Generates a random key.</p>
|
||||
<pre><code class="lang-csharp">public string GenerateKey()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The key.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey"> GetMasterKey()</h3>
|
||||
<p>Gets the master key.</p>
|
||||
<pre><code class="lang-csharp">public byte[] GetMasterKey()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>An array of byte.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></p>
|
||||
<p>Thrown when the requested operation is invalid.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts"> GetNumParts()</h3>
|
||||
<p>Gets the number parts.</p>
|
||||
<pre><code class="lang-csharp">public int GetNumParts()
|
||||
</code></pre>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The number parts.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></p>
|
||||
<p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize"> GetSaltSize()</h3>
|
||||
<p>Gets the salt size.</p>
|
||||
<pre><code class="lang-csharp">public int GetSaltSize()
|
||||
</code></pre>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The salt size.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"> SetMasterKeyAccessor(Func<byte[]>)</h3>
|
||||
<p>Sets the master key.</p>
|
||||
<pre><code class="lang-csharp">public void SetMasterKeyAccessor(Func<byte[]> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"> SetNumPartsAccessor(Func<int>)</h3>
|
||||
<p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
||||
<pre><code class="lang-csharp">public void SetNumPartsAccessor(Func<int> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__"> SetSaltSizeAccessor(Func<int>)</h3>
|
||||
<p>Sets the salt size (in bytes). Default is 4.</p>
|
||||
<pre><code class="lang-csharp">public void SetSaltSizeAccessor(Func<int> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_"> ValidateKey(string)</h3>
|
||||
<p>Validates the provided key.</p>
|
||||
<pre><code class="lang-csharp">public bool ValidateKey(string providedKey)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>providedKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The provided key.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True if it succeeds, false if it fails.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_GetMasterKey">GetMasterKey</a>(),
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____">SetMasterKeyAccessor</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]>),
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.masterKeyAccessor</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,134 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class LanguageHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class LanguageHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_LanguageHelper"> Class LanguageHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Helper class for handling text transformations.</p>
|
||||
<pre><code class="lang-csharp">public class LanguageHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.LanguageHelper.html">LanguageHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<LanguageHelper>(LanguageHelper, LanguageHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_"> CamelCaseToHumanReadable(string)</h3>
|
||||
<p>Converts camel case text to human readable text.</p>
|
||||
<pre><code class="lang-csharp">public static string CamelCaseToHumanReadable(string value)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The value.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string in human readable format.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>Camel case is a naming convention for identifiers in which the first letter of each word is
|
||||
capitalized.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,302 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class SecurityHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class SecurityHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_SecurityHelper"> Class SecurityHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||
<pre><code class="lang-csharp">public class SecurityHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<SecurityHelper>(SecurityHelper, SecurityHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1_CapyKit_Password_System_String_System_Byte___System_Object___"> CompareHashedPassword<T>(Password, string, byte[], params object[])</h3>
|
||||
<p>Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
|
||||
This method uses the specified password algorithm type <code class="typeparamref">T</code> to retrieve the hashed version
|
||||
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.</p>
|
||||
<pre><code class="lang-csharp">public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>existingPassword</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>The existing, encrypted password.</p>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The unencrypted password to be compared.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The salt value used in password hashing.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if hash comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it fails.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the password hashing algorithm.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_CapyKit_Password_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"> CompareHashedPassword(Password, string, byte[], IPasswordAlgorithm, params object[])</h3>
|
||||
<p>Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
|
||||
This method uses the specified <code class="paramref">algorithm</code> to retrieve the hashed version
|
||||
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.</p>
|
||||
<pre><code class="lang-csharp">public static bool CompareHashedPassword(Password existingPassword, string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>existingPassword</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>The existing, encrypted password.</p>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The unencrypted password to be compared.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The salt value used in password hashing.</p>
|
||||
<p><code>algorithm</code> <a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>The password hashing algorithm.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if hash comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it fails.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareSessionID_System_String_System_String_"> CompareSessionID(string, string)</h3>
|
||||
<p>Compares two session identifiers.</p>
|
||||
<pre><code class="lang-csharp">public static bool CompareSessionID(string first, string second)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>first</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The first session identifier.</p>
|
||||
<p><code>second</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The second session identifier.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if not.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Object___"> GetPassword<T>(string, params object[])</h3>
|
||||
<p>Retrieves a <span class="xref">CapyKit.Password</span> object using the specified password and generates a random salt value.
|
||||
Then it uses that salt to call the overloaded <span class="xref">CapyKit.Helpers.SecurityHelper.GetPassword``1(System.String,System.Byte[],System.Object[])</span> method with the given password and
|
||||
the generated salt as arguments.</p>
|
||||
<pre><code class="lang-csharp">public static Password GetPassword<T>(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to be hashed.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Optional constructor arguments for the <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation
|
||||
instance.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object with the given password and a randomly generated salt, as well as an
|
||||
instance of <code class="typeparamref">T</code> created using any optional constructor arguments provided.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation to use.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a>.SALT_SIZE</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object___"> GetPassword<T>(string, byte[], params object[])</h3>
|
||||
<p>Retrieves a <span class="xref">CapyKit.Password</span> object using the specified password, salt, and optional
|
||||
constructor arguments.</p>
|
||||
<pre><code class="lang-csharp">public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to be hashed.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A random value used as an additional input to the one-way function that hashes data, a
|
||||
password or passphrase. This is used to make each output different for the same input
|
||||
thus adding security.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Optional constructor arguments for the <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation
|
||||
instance.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object with the given password and salt, as well as an instance
|
||||
of <code class="typeparamref">T</code> created using the provided constructor arguments.</p>
|
||||
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation to use.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method uses reflection to find a constructor for the specified password algorithm type (<code class="typeparamref">T</code>).
|
||||
It emits an error event if a suitable constructor is not found or if there is an error invoking the constructor.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomPassword_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"> GetRandomPassword(int, params ValidCharacterCollection[])</h3>
|
||||
<p>Gets a cryptographically strong random password.</p>
|
||||
<pre><code class="lang-csharp">public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The length of the password to generate.</p>
|
||||
<p><code>validCharacters</code> <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</p>
|
||||
<p>An array of <span class="xref">CapyKit.Helpers.ValidCharacterCollection</span> enumeration values representing the desired
|
||||
character sets.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The password.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_"> GetRandomString(int)</h3>
|
||||
<p>A convenience method to generate a random string of the specified length using all character sets.</p>
|
||||
<pre><code class="lang-csharp">public static string GetRandomString(int length)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The desired length of the generated random string.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h4 id="see-also-1">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>,
|
||||
<a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a>.<a href="CapyKit.Helpers.SecurityHelper.html#CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___">GetRandomString</a>(<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, params <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[])</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"> GetRandomString(int, params ValidCharacterCollection[])</h3>
|
||||
<p>Gets a cryptographically strong random string using the character values found in VALID_CHARACTERS.</p>
|
||||
<pre><code class="lang-csharp">public static string GetRandomString(int length, params ValidCharacterCollection[] validChars)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The length of the string to create.</p>
|
||||
<p><code>validChars</code> <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The random string.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32_"> GetSalt(int)</h3>
|
||||
<p>Generates a random byte array that can act as a salt.</p>
|
||||
<pre><code class="lang-csharp">public static byte[] GetSalt(int length = 32)
|
||||
</code></pre>
|
||||
<h4 id="parameters-8">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>(Optional) The desired length of the generated byte array.</p>
|
||||
<h4 id="returns-8">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>An array of byte.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>A default length of <span class="xref">CapyKit.Helpers.SecurityHelper.SALT_SIZE</span> is provided as a sane default. Larger values can be used for increased
|
||||
entropy.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_System_Byte___"> Pbkdf2(string, byte[])</h3>
|
||||
<p>Generates a new <span class="xref">CapyKit.Password</span> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>
|
||||
and <code class="paramref">salt</code>.</p>
|
||||
<pre><code class="lang-csharp">public static Password Pbkdf2(string password, byte[] salt)
|
||||
</code></pre>
|
||||
<h4 id="parameters-9">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The clear text password to be hashed.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A random value used to add an additional layer of security to the generated hash.</p>
|
||||
<h4 id="returns-9">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object containing the hashed password and salt.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate
|
||||
a new password hash. The algorithm iteratively applies a pseudorandom function to the
|
||||
password and salt, which increases the security of the resulting hash.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_"> Pbkdf2(string)</h3>
|
||||
<p>Generates a new <span class="xref">CapyKit.Password</span> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>.
|
||||
This overload of the method generates a random salt value for added security.</p>
|
||||
<pre><code class="lang-csharp">public static Password Pbkdf2(string password)
|
||||
</code></pre>
|
||||
<h4 id="parameters-10">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The clear text password to be hashed.</p>
|
||||
<h4 id="returns-10">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object containing the hashed password and a randomly generated salt.</p>
|
||||
<h4 id="remarks-3">Remarks</h4>
|
||||
<p>This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate
|
||||
a new password hash. The algorithm iteratively applies a pseudorandom function to the
|
||||
password and salt, which increases the security of the resulting hash. In this overload,
|
||||
a random salt value is generated using <span class="xref">CapyKit.Helpers.SecurityHelper.GetRandomBytes(System.Int32)</span> method.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,184 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class SerializationHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class SerializationHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_SerializationHelper"> Class SerializationHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public static class SerializationHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.SerializationHelper.html">SerializationHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___"> Deserialize<T>(byte[])</h3>
|
||||
<p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||
<pre><code class="lang-csharp">public static T Deserialize<T>(byte[] bytes)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>bytes</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The byte array representing a <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></p>
|
||||
<p>Thrown when the format of the byte array is incorrect.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_IO_Stream_"> Deserialize<T>(Stream)</h3>
|
||||
<p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||
<pre><code class="lang-csharp">public static T Deserialize<T>(Stream stream)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>stream</code> <a href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></p>
|
||||
<p>The steam.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></p>
|
||||
<p>Thrown when the format of an input is incorrect.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_String_"> Deserialize<T>(string)</h3>
|
||||
<p>Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.</p>
|
||||
<pre><code class="lang-csharp">public static T Deserialize<T>(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_"> SerializeToBytes(object)</h3>
|
||||
<p>Serializes an object to a byte array.</p>
|
||||
<pre><code class="lang-csharp">public static byte[] SerializeToBytes(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A <code>JSON</code> encoded string.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_"> SerializeToString(object)</h3>
|
||||
<p>Serializes an object to a <code>JSON</code> encoded string.</p>
|
||||
<pre><code class="lang-csharp">public static string SerializeToString(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A <code>JSON</code> encoded string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,187 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class SettingsHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class SettingsHelper | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_SettingsHelper"> Class SettingsHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||
<pre><code class="lang-csharp">public static class SettingsHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.SettingsHelper.html">SettingsHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="examples">Examples</h2>
|
||||
<p>This example demonstrates how to set up the SettingsHelper class with custom accessor and
|
||||
detector methods that read from an App.config file. The setup is done at the beginning of the
|
||||
application execution, before any other usage of the helper methods.</p>
|
||||
<pre><code class="lang-csharp">public int main(string[] args)
|
||||
{
|
||||
// Set up SettingsHelper with custom accessor and detector methods
|
||||
Func<string, object> accessor = (key) =>
|
||||
{
|
||||
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
|
||||
return config.AppSettings.Settings[key].Value;
|
||||
};
|
||||
|
||||
Func<string, bool> detector = (key) =>
|
||||
{
|
||||
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
|
||||
return config.AppSettings.Settings.AllKeys.Contains(key);
|
||||
};
|
||||
|
||||
SettingsHelper.SetAccessorMethod(accessor);
|
||||
SettingsHelper.SetDetectorMethod(detector);
|
||||
|
||||
// Use the helper to retrieve and set settings
|
||||
SettingsHelper.SetApplicationSetting<int>("MySettingKey", 42);
|
||||
int newSetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
||||
Console.WriteLine("New setting: {0}", newSetting);
|
||||
|
||||
int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
||||
Console.WriteLine("Retrieved setting: {0}", mySetting);
|
||||
}</code></pre>
|
||||
<h2 id="remarks">Remarks</h2>
|
||||
<p>The specific means of accessing and storing the settings are determined by the consumer,
|
||||
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
|
||||
.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_"> GetApplicationSetting<T>(string)</h3>
|
||||
<p>Retrieves a setting with the given <code>key</code>.</p>
|
||||
<pre><code class="lang-csharp">public static T GetApplicationSetting<T>(string settingName)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>settingName</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the setting to retrieve.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>The value of the setting as an uncast <code class="typeparamref">T</code>.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the setting to be retrieved.</p>
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__"> SetAccessorMethod(Func<string, object>)</h3>
|
||||
<p>Sets the function used to retrieve application settings.</p>
|
||||
<pre><code class="lang-csharp">public static void SetAccessorMethod(Func<string, object> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></p>
|
||||
<p>The new function used to retrieve application settings.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>Thrown when one or more required arguments are null.</p>
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__"> SetDetectorMethod(Func<string, bool>)</h3>
|
||||
<p>Sets the function used to detect if an application setting with a given <code>key</code> exists.</p>
|
||||
<pre><code class="lang-csharp">public static void SetDetectorMethod(Func<string, bool> detector)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>detector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></p>
|
||||
<p>The new function used to detect if an application setting exists.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>Thrown when one or more required arguments are null.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,124 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Enum ValidCharacterCollection | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Enum ValidCharacterCollection | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers_ValidCharacterCollection"> Enum ValidCharacterCollection</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An enumeration that defines the types of characters that can be included in a random string.</p>
|
||||
<pre><code class="lang-csharp">public enum ValidCharacterCollection
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string, bool)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<ValidCharacterCollection>(ValidCharacterCollection, ValidCharacterCollection)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<p><code>Lowercase = 0</code></p>
|
||||
<p>Indicates that lower case characters should be included in the random string.</p>
|
||||
<p><code>Numbers = 2</code></p>
|
||||
<p>Indicates that numeric characters should be included in the random string.</p>
|
||||
<p><code>Special = 3</code></p>
|
||||
<p>Indicates that special characters should be included in the random string.</p>
|
||||
<p><code>Uppercase = 1</code></p>
|
||||
<p>Indicates that upper case characters should be included in the random string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,121 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Namespace CapyKit.Helpers | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Namespace CapyKit.Helpers | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Helpers"> Namespace CapyKit.Helpers</h1>
|
||||
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></p>
|
||||
<p>Static class providing helper methods for various calculations.</p>
|
||||
<p><a href="CapyKit.Helpers.CompressionHelper.html">CompressionHelper</a></p>
|
||||
<p>A class that contains methods for managing data compression.</p>
|
||||
<p><a href="CapyKit.Helpers.EncryptionHelper.html">EncryptionHelper</a></p>
|
||||
<p><a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
||||
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
<p><a href="CapyKit.Helpers.LanguageHelper.html">LanguageHelper</a></p>
|
||||
<p>Helper class for handling text transformations.</p>
|
||||
<p><a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a></p>
|
||||
<p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||
<p><a href="CapyKit.Helpers.SerializationHelper.html">SerializationHelper</a></p>
|
||||
<p><a href="CapyKit.Helpers.SettingsHelper.html">SettingsHelper</a></p>
|
||||
<p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||
<h3 id="interfaces">Interfaces</h3>
|
||||
<p><a href="CapyKit.Helpers.IEncryptionAlgorithm.html">IEncryptionAlgorithm</a></p>
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a></p>
|
||||
<p>An enumeration that defines the types of characters that can be included in a random string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,144 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Interface IPasswordAlgorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Interface IPasswordAlgorithm | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_IPasswordAlgorithm"> Interface IPasswordAlgorithm</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Defines the contract for password encryption algorithms.</p>
|
||||
<pre><code class="lang-csharp">public interface IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<p>Gets the name of the algorithm.</p>
|
||||
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___"> Compare(string, byte[], params object[])</h3>
|
||||
<p>Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">bool Compare(string password, byte[] encryptedValue, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to compare.</p>
|
||||
<p><code>encryptedValue</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The encrypted value to compare against.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
|
||||
false if they are different.</p>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||
<p>Encrypts the given password using a defined algorithm.</p>
|
||||
<pre><code class="lang-csharp">byte[] Encrypt(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,194 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class Password | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class Password | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Password"> Class Password</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
<pre><code class="lang-csharp">public class Password
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Password.html">Password</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Password>(Password, Password)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"> Password(string, byte[], IPasswordAlgorithm, params object[])</h3>
|
||||
<p>Constructor.</p>
|
||||
<pre><code class="lang-csharp">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The password to be hashed.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The salt used for encryption.</p>
|
||||
<p><code>algorithm</code> <a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>The algorithm used for password encryption.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Password_Algorithm"> Algorithm</h3>
|
||||
<p>Gets or sets the algorithm used for password encryption.</p>
|
||||
<pre><code class="lang-csharp">public IPasswordAlgorithm Algorithm { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<h3 id="CapyKit_Password_Hash"> Hash</h3>
|
||||
<p>Gets or sets the hash of the password.</p>
|
||||
<pre><code class="lang-csharp">public byte[] Hash { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<h3 id="CapyKit_Password_Pbkdf2Algorithm"> Pbkdf2Algorithm</h3>
|
||||
<p>Gets the preconfigured PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<h3 id="CapyKit_Password_Salt"> Salt</h3>
|
||||
<p>Gets or sets the salt used for encryption.</p>
|
||||
<pre><code class="lang-csharp">public byte[] Salt { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-3">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Password_Equals_System_Object_"> Equals(object?)</h3>
|
||||
<p>Determines whether the specified object is equal to the current object.</p>
|
||||
<pre><code class="lang-csharp">public override bool Equals(object? obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>?</p>
|
||||
<p>The object to compare with the current object.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
<h3 id="CapyKit_Password_ToString"> ToString()</h3>
|
||||
<p>Returns a string that represents the current object.</p>
|
||||
<pre><code class="lang-csharp">public override string ToString()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string that represents the current object.</p>
|
||||
<h2 id="operators">Operators</h2>
|
||||
<h3 id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_"> operator ==(Password, Password)</h3>
|
||||
<pre><code class="lang-csharp">public static bool operator ==(Password a, Password b)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<h3 id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_"> operator !=(Password, Password)</h3>
|
||||
<pre><code class="lang-csharp">public static bool operator !=(Password a, Password b)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,165 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class Pbkdf2Algorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class Pbkdf2Algorithm | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Pbkdf2Algorithm"> Class Pbkdf2Algorithm</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
<pre><code class="lang-csharp">public class Pbkdf2Algorithm : IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<h4 id="implements">Implements</h4>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Pbkdf2Algorithm>(Pbkdf2Algorithm, Pbkdf2Algorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm__ctor"> Pbkdf2Algorithm()</h3>
|
||||
<p>Default constructor.</p>
|
||||
<pre><code class="lang-csharp">public Pbkdf2Algorithm()
|
||||
</code></pre>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_ITERATIONS"> ITERATIONS</h3>
|
||||
<p>The default number of iterations.</p>
|
||||
<pre><code class="lang-csharp">public const int ITERATIONS = 100000
|
||||
</code></pre>
|
||||
<h4 id="field-value">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This member is immutable.</p>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_LENGTH"> LENGTH</h3>
|
||||
<p>(Immutable) The default length.</p>
|
||||
<pre><code class="lang-csharp">public const int LENGTH = 32
|
||||
</code></pre>
|
||||
<h4 id="field-value-1">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>This member is immutable.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<p>Gets the name of the algorithm.</p>
|
||||
<pre><code class="lang-csharp">public string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||
<p>Encrypts the given password using a PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">public byte[] Encrypt(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, specifically</p>
|
||||
<ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,168 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class Pool<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class Pool<T> | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_Pool_1"> Class Pool<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<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>
|
||||
<pre><code class="lang-csharp">public class Pool<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of objects to be managed by the pool.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Pool<T>>(Pool<T>, Pool<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_"> Pool(int)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size.</p>
|
||||
<pre><code class="lang-csharp">public Pool(int poolSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The size of the pool.</p>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__"> Pool(int, Func<T>)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size
|
||||
and constructor selector.</p>
|
||||
<pre><code class="lang-csharp">public Pool(int poolSize, Func<T> constructorSelector)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The size of the pool.</p>
|
||||
<p><code>constructorSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></p>
|
||||
<p>The constructor selector used to create new instances of <code class="typeparamref">T</code>.</p>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__"> Pool(IEnumerable<T>)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified collection
|
||||
of items.</p>
|
||||
<pre><code class="lang-csharp">public Pool(IEnumerable<T> collection)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>collection</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The collection of <code class="typeparamref">T</code> items with which to seed the pool.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Pool_1_GetAvailableItem"> GetAvailableItem()</h3>
|
||||
<p>Gets the first available item from the pool and sets its lock.</p>
|
||||
<pre><code class="lang-csharp">public PoolItem<T> GetAvailableItem()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||
<p>The first available item from the pool.</p>
|
||||
<h3 id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0__"> ReleaseItem(PoolItem<T>)</h3>
|
||||
<p>Releases the lock on the specified item and returns it to the pool.</p>
|
||||
<pre><code class="lang-csharp">public void ReleaseItem(PoolItem<T> item)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>item</code> <a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||
<p>The item to release.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method sets the <span class="xref">CapyKit.PoolItem`1.Locked</span> flag to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> so that
|
||||
it can be retrieved by <span class="xref">CapyKit.Pool`1.GetAvailableItem</span>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,171 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class PoolItem<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class PoolItem<T> | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_PoolItem_1"> Class PoolItem<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A pool item. This class cannot be inherited.</p>
|
||||
<pre><code class="lang-csharp">public sealed class PoolItem<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the pooled item.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<PoolItem<T>>(PoolItem<T>, PoolItem<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_PoolItem_1_Index"> Index</h3>
|
||||
<p>Gets the zero-based index of the pooled item.</p>
|
||||
<pre><code class="lang-csharp">public int Index { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h3 id="CapyKit_PoolItem_1_Item"> Item</h3>
|
||||
<p>Gets the pooled resource.</p>
|
||||
<pre><code class="lang-csharp">public T Item { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p>T</p>
|
||||
<h3 id="CapyKit_PoolItem_1_Locked"> Locked</h3>
|
||||
<p>Gets a value indicating whether this object is locked or not.</p>
|
||||
<pre><code class="lang-csharp">public bool Locked { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<h3 id="CapyKit_PoolItem_1_TypeName"> TypeName</h3>
|
||||
<p>Gets the name of the <span class="xref">System.Type</span> of the pooled item.</p>
|
||||
<pre><code class="lang-csharp">public string TypeName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-3">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_PoolItem_1_ReleaseLock"> ReleaseLock()</h3>
|
||||
<p>Releases the lock on the item.</p>
|
||||
<pre><code class="lang-csharp">public void ReleaseLock()
|
||||
</code></pre>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>If the item is not locked, an error event is emitted.</p>
|
||||
<h3 id="CapyKit_PoolItem_1_SetLock"> SetLock()</h3>
|
||||
<p>Sets the lock on the item indicating that it is in use.</p>
|
||||
<pre><code class="lang-csharp">public bool SetLock()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is locked successfully, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it
|
||||
fails.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>If the item is already locked, an error event is emitted.</p>
|
||||
<h3 id="CapyKit_PoolItem_1_ToString"> ToString()</h3>
|
||||
<p>Returns a string that represents the current object and its lock state.</p>
|
||||
<pre><code class="lang-csharp">public override string ToString()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string that represents the current object and its lock state.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,192 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title> Class PropertyComparer<T, U> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content=" Class PropertyComparer<T, U> | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit_PropertyComparer_2"> Class PropertyComparer<T, U></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
<pre><code class="lang-csharp">public class PropertyComparer<T, U> : IEqualityComparer<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter of the parent object.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter of the property value.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||
<h4 id="implements">Implements</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer-1">IEqualityComparer<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<PropertyComparer<T, U>>(PropertyComparer<T, U>, PropertyComparer<T, U>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="examples">Examples</h2>
|
||||
<p>using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;</p>
|
||||
<p>class Program
|
||||
{
|
||||
static void Main(string[] args)
|
||||
{
|
||||
var people = new List<Person>
|
||||
{
|
||||
new Person { Name = "Alice", Age = 30 }, new Person { Name = "Bob", Age = 30 }, new
|
||||
Person { Name = "Charlie", Age = 35 }
|
||||
};</p>
|
||||
<pre><code> var comparer = new PropertyComparer<Person, int>(p => p.Age);
|
||||
var distinctPeople = people.Distinct(comparer).ToList();
|
||||
|
||||
foreach (var person in distinctPeople)
|
||||
{
|
||||
Console.WriteLine($"{person.Name} - {person.Age}");
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>}</p>
|
||||
<p>class Person
|
||||
{
|
||||
public string Name { get; set; }
|
||||
public int Age { get; set; }
|
||||
}</p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__"> PropertyComparer(Func<T, U>)</h3>
|
||||
<p>Constructor.</p>
|
||||
<pre><code class="lang-csharp">public PropertyComparer(Func<T, U> expression)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>expression</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>The expression.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_PropertyComparer_2_Equals__0__0_"> Equals(T, T)</h3>
|
||||
<p>Determines whether the specified properties are equal.</p>
|
||||
<pre><code class="lang-csharp">public bool Equals(T x, T y)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>x</code> T</p>
|
||||
<p>The first object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
<p><code>y</code> T</p>
|
||||
<p>The second object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified objects are equal; otherwise,
|
||||
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
<h3 id="CapyKit_PropertyComparer_2_GetHashCode__0_"> GetHashCode(T)</h3>
|
||||
<p>Returns a hash code for the specified object.</p>
|
||||
<pre><code class="lang-csharp">public int GetHashCode(T obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>obj</code> T</p>
|
||||
<p>The <span class="xref">System.Object</span> for which a hash code is to be returned.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>A hash code for the specified object.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>The type of <code class="paramref">obj</code> is a reference type and
|
||||
<code class="paramref">obj</code> is
|
||||
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,138 +0,0 @@
|
|||
<!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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="CapyKit"> Namespace CapyKit</h1>
|
||||
|
||||
<h3 id="namespaces">Namespaces</h3>
|
||||
<p><a href="CapyKit.Attributes.html">CapyKit.Attributes</a></p>
|
||||
<p><a href="CapyKit.Enumerations.html">CapyKit.Enumerations</a></p>
|
||||
<p><a href="CapyKit.Extensions.html">CapyKit.Extensions</a></p>
|
||||
<p><a href="CapyKit.Helpers.html">CapyKit.Helpers</a></p>
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
method name information.</p>
|
||||
<p><a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
<p><a href="CapyKit.Color.html">Color</a></p>
|
||||
<p>An object representing a color.</p>
|
||||
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></p>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
<p><a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||
<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>
|
||||
<p><a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||
<p>A pool item. This class cannot be inherited.</p>
|
||||
<p><a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
<h3 id="interfaces">Interfaces</h3>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>Defines the contract for password encryption algorithms.</p>
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>Enumeration representing different event level severity values.</p>
|
||||
<p><a href="CapyKit.NamedColor.html">NamedColor</a></p>
|
||||
<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>
|
||||
<h3 id="delegates">Delegates</h3>
|
||||
<p><a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>A delegate representing an event handler that accepts a <span class="xref">CapyKit.CapyEventArgs</span> instance.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,177 +0,0 @@
|
|||
|
||||
<div id="sidetoggle">
|
||||
<div>
|
||||
<div class="sidefilter">
|
||||
<form class="toc-filter">
|
||||
<span class="glyphicon glyphicon-filter filter-icon"></span>
|
||||
<span class="glyphicon glyphicon-remove clear-icon" id="toc_filter_clear"></span>
|
||||
<input type="text" id="toc_filter_input" placeholder="Filter by title" onkeypress="if(event.keyCode==13) {return false;}">
|
||||
</form>
|
||||
</div>
|
||||
<div class="sidetoc">
|
||||
<div class="toc" id="toc">
|
||||
|
||||
<ul class="nav level1">
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="CapyKit.html" name="" title="CapyKit">CapyKit</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Color.html" name="" title="Color">Color</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Password.html" name="" title="Password">Password</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Interfaces">Interfaces</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.IPasswordAlgorithm.html" name="" title="IPasswordAlgorithm">IPasswordAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.EventLevel.html" name="" title="EventLevel">EventLevel</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.NamedColor.html" name="" title="NamedColor">NamedColor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Delegates">Delegates</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventHandler.html" name="" title="CapyEventHandler">CapyEventHandler</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Attributes.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Attributes.EnumerationDescriptionAttribute.html" name="" title="EnumerationDescriptionAttribute">EnumerationDescriptionAttribute</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Attributes.ValueFormatAttribute.html" name="" title="ValueFormatAttribute">ValueFormatAttribute</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Enumerations.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.LINQExtensions.html" name="" title="LINQExtensions">LINQExtensions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html" name="" title="ObjectExtensions">ObjectExtensions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.StringExtensions.html" name="" title="StringExtensions">StringExtensions</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.CompressionHelper.html" name="" title="CompressionHelper">CompressionHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.LanguageHelper.html" name="" title="LanguageHelper">LanguageHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.SecurityHelper.html" name="" title="SecurityHelper">SecurityHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.SerializationHelper.html" name="" title="SerializationHelper">SerializationHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.html" name="" title="Interfaces">Interfaces</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
|
||||
{"order":100,"items":[{"name":"CapyKit","href":"CapyKit.html","topicHref":"CapyKit.html","items":[{"name":"Classes"},{"name":"CapyEventArgs","href":"CapyKit.CapyEventArgs.html","topicHref":"CapyKit.CapyEventArgs.html"},{"name":"CapyEventReporter","href":"CapyKit.CapyEventReporter.html","topicHref":"CapyKit.CapyEventReporter.html"},{"name":"Color","href":"CapyKit.Color.html","topicHref":"CapyKit.Color.html"},{"name":"EncryptedValue<T>","href":"CapyKit.EncryptedValue-1.html","topicHref":"CapyKit.EncryptedValue-1.html"},{"name":"Password","href":"CapyKit.Password.html","topicHref":"CapyKit.Password.html"},{"name":"Pbkdf2Algorithm","href":"CapyKit.Pbkdf2Algorithm.html","topicHref":"CapyKit.Pbkdf2Algorithm.html"},{"name":"Pool<T>","href":"CapyKit.Pool-1.html","topicHref":"CapyKit.Pool-1.html"},{"name":"PoolItem<T>","href":"CapyKit.PoolItem-1.html","topicHref":"CapyKit.PoolItem-1.html"},{"name":"PropertyComparer<T, U>","href":"CapyKit.PropertyComparer-2.html","topicHref":"CapyKit.PropertyComparer-2.html"},{"name":"Interfaces"},{"name":"IPasswordAlgorithm","href":"CapyKit.IPasswordAlgorithm.html","topicHref":"CapyKit.IPasswordAlgorithm.html"},{"name":"Enums"},{"name":"EventLevel","href":"CapyKit.EventLevel.html","topicHref":"CapyKit.EventLevel.html"},{"name":"NamedColor","href":"CapyKit.NamedColor.html","topicHref":"CapyKit.NamedColor.html"},{"name":"Delegates"},{"name":"CapyEventHandler","href":"CapyKit.CapyEventHandler.html","topicHref":"CapyKit.CapyEventHandler.html"}]},{"name":"CapyKit.Attributes","href":"CapyKit.Attributes.html","topicHref":"CapyKit.Attributes.html","items":[{"name":"Classes"},{"name":"EnumerationAttribute<T>","href":"CapyKit.Attributes.EnumerationAttribute-1.html","topicHref":"CapyKit.Attributes.EnumerationAttribute-1.html"},{"name":"EnumerationDescriptionAttribute","href":"CapyKit.Attributes.EnumerationDescriptionAttribute.html","topicHref":"CapyKit.Attributes.EnumerationDescriptionAttribute.html"},{"name":"ValueFormatAttribute","href":"CapyKit.Attributes.ValueFormatAttribute.html","topicHref":"CapyKit.Attributes.ValueFormatAttribute.html"}]},{"name":"CapyKit.Enumerations","href":"CapyKit.Enumerations.html","topicHref":"CapyKit.Enumerations.html","items":[{"name":"Enums"},{"name":"MeasurementSystem","href":"CapyKit.Enumerations.MeasurementSystem.html","topicHref":"CapyKit.Enumerations.MeasurementSystem.html"}]},{"name":"CapyKit.Extensions","href":"CapyKit.Extensions.html","topicHref":"CapyKit.Extensions.html","items":[{"name":"Classes"},{"name":"EnumerationExtensions","href":"CapyKit.Extensions.EnumerationExtensions.html","topicHref":"CapyKit.Extensions.EnumerationExtensions.html"},{"name":"LINQExtensions","href":"CapyKit.Extensions.LINQExtensions.html","topicHref":"CapyKit.Extensions.LINQExtensions.html"},{"name":"ObjectExtensions","href":"CapyKit.Extensions.ObjectExtensions.html","topicHref":"CapyKit.Extensions.ObjectExtensions.html"},{"name":"StringExtensions","href":"CapyKit.Extensions.StringExtensions.html","topicHref":"CapyKit.Extensions.StringExtensions.html"}]},{"name":"CapyKit.Helpers","href":"CapyKit.Helpers.html","topicHref":"CapyKit.Helpers.html","items":[{"name":"Classes"},{"name":"CalculationHelper","href":"CapyKit.Helpers.CalculationHelper.html","topicHref":"CapyKit.Helpers.CalculationHelper.html"},{"name":"CompressionHelper","href":"CapyKit.Helpers.CompressionHelper.html","topicHref":"CapyKit.Helpers.CompressionHelper.html"},{"name":"EncryptionHelper","href":"CapyKit.Helpers.EncryptionHelper.html","topicHref":"CapyKit.Helpers.EncryptionHelper.html"},{"name":"KeyHelper","href":"CapyKit.Helpers.KeyHelper.html","topicHref":"CapyKit.Helpers.KeyHelper.html"},{"name":"LanguageHelper","href":"CapyKit.Helpers.LanguageHelper.html","topicHref":"CapyKit.Helpers.LanguageHelper.html"},{"name":"SecurityHelper","href":"CapyKit.Helpers.SecurityHelper.html","topicHref":"CapyKit.Helpers.SecurityHelper.html"},{"name":"SerializationHelper","href":"CapyKit.Helpers.SerializationHelper.html","topicHref":"CapyKit.Helpers.SerializationHelper.html"},{"name":"SettingsHelper","href":"CapyKit.Helpers.SettingsHelper.html","topicHref":"CapyKit.Helpers.SettingsHelper.html"},{"name":"Interfaces"},{"name":"IEncryptionAlgorithm","href":"CapyKit.Helpers.IEncryptionAlgorithm.html","topicHref":"CapyKit.Helpers.IEncryptionAlgorithm.html"},{"name":"Enums"},{"name":"ValidCharacterCollection","href":"CapyKit.Helpers.ValidCharacterCollection.html","topicHref":"CapyKit.Helpers.ValidCharacterCollection.html"}]}],"pdf":false}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 97 KiB |
|
|
@ -1,189 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Getting Started | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Getting Started | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="getting-started">Getting Started</h1>
|
||||
|
||||
<p>This guide shows the common setup and first-use patterns for consuming CapyKit from a .NET 8 project.</p>
|
||||
<h2 id="install">Install</h2>
|
||||
<p>Add CapyKit to your project from NuGet:</p>
|
||||
<pre><code class="lang-bash">dotnet add package CapyKit
|
||||
</code></pre>
|
||||
<p>If you are working from a local checkout instead, reference the project directly:</p>
|
||||
<pre><code class="lang-bash">dotnet add reference ../CapyKit/CapyKit.csproj
|
||||
</code></pre>
|
||||
<h2 id="add-namespaces">Add Namespaces</h2>
|
||||
<p>Most APIs live in one of three namespaces:</p>
|
||||
<pre><code class="lang-csharp">using CapyKit;
|
||||
using CapyKit.Extensions;
|
||||
using CapyKit.Helpers;
|
||||
</code></pre>
|
||||
<p>Use <code>CapyKit</code> for core types such as <code>Password</code>, <code>Pool<T></code>, and <code>CapyEventReporter</code>. Use <code>CapyKit.Extensions</code> for extension methods. Use <code>CapyKit.Helpers</code> for serialization, compression, security, keys, language, and calculation helpers.</p>
|
||||
<h2 id="work-with-strings">Work With Strings</h2>
|
||||
<pre><code class="lang-csharp">using CapyKit.Extensions;
|
||||
|
||||
string? suppliedName = "";
|
||||
string name = suppliedName.IfNullOrWhiteSpace("Guest");
|
||||
</code></pre>
|
||||
<p><code>IfNullOrEmpty</code> and <code>IfNullOrWhiteSpace</code> return the original value when it is usable and return your replacement value when it is not.</p>
|
||||
<h2 id="page-and-filter-collections">Page And Filter Collections</h2>
|
||||
<pre><code class="lang-csharp">using CapyKit.Extensions;
|
||||
|
||||
var activeUsers = users.Filter(user => user.Disabled);
|
||||
var secondPage = activeUsers.Page(pageNumber: 2, pageSize: 25);
|
||||
int pageCount = activeUsers.PageCount(pageSize: 25);
|
||||
</code></pre>
|
||||
<p><code>Filter</code> removes items that match the predicate. <code>Page</code> uses natural page numbering, so the first page is <code>1</code>.</p>
|
||||
<h2 id="serialize-and-compress-data">Serialize And Compress Data</h2>
|
||||
<pre><code class="lang-csharp">using CapyKit.Helpers;
|
||||
|
||||
var json = SerializationHelper.SerializeToString(order);
|
||||
var copy = SerializationHelper.Deserialize<Order>(json);
|
||||
|
||||
var compressed = CompressionHelper.CompressToString(order);
|
||||
var restored = CompressionHelper.Decompress<Order>(compressed);
|
||||
</code></pre>
|
||||
<p>Serialization uses <code>System.Text.Json</code>. Compression stores the serialized JSON payload using gzip; <code>CompressToString</code> returns a Base64 representation for easier storage or transport.</p>
|
||||
<h2 id="hash-and-verify-passwords">Hash And Verify Passwords</h2>
|
||||
<pre><code class="lang-csharp">using CapyKit;
|
||||
using CapyKit.Helpers;
|
||||
|
||||
Password storedPassword = SecurityHelper.Pbkdf2("correct horse battery staple");
|
||||
|
||||
bool passwordMatches = SecurityHelper.CompareHashedPassword(
|
||||
storedPassword,
|
||||
"correct horse battery staple",
|
||||
storedPassword.Salt,
|
||||
Password.Pbkdf2Algorithm);
|
||||
</code></pre>
|
||||
<p><code>SecurityHelper.Pbkdf2</code> creates a <code>Password</code> with a random salt. Store the hash, salt, and algorithm information required by your application, then compare future password attempts using the same salt and algorithm.</p>
|
||||
<h2 id="generate-random-values">Generate Random Values</h2>
|
||||
<pre><code class="lang-csharp">using CapyKit.Helpers;
|
||||
|
||||
string token = SecurityHelper.GetRandomString(32);
|
||||
string password = SecurityHelper.GetRandomPassword(
|
||||
20,
|
||||
ValidCharacterCollection.Lowercase,
|
||||
ValidCharacterCollection.Uppercase,
|
||||
ValidCharacterCollection.Numbers,
|
||||
ValidCharacterCollection.Special);
|
||||
</code></pre>
|
||||
<p>Random string and password generation use .NET cryptographic random number generation.</p>
|
||||
<h2 id="create-and-validate-keys">Create And Validate Keys</h2>
|
||||
<pre><code class="lang-csharp">using System.Text;
|
||||
using CapyKit.Helpers;
|
||||
|
||||
var keyHelper = new KeyHelper();
|
||||
keyHelper.SetMasterKeyAccessor(() => Encoding.UTF8.GetBytes("replace-with-your-master-key"));
|
||||
keyHelper.SetSaltSizeAccessor(() => 8);
|
||||
keyHelper.SetNumPartsAccessor(() => 4);
|
||||
|
||||
string key = keyHelper.GenerateKey();
|
||||
bool valid = keyHelper.ValidateKey(key);
|
||||
</code></pre>
|
||||
<p><code>KeyHelper</code> uses an application-provided master key to sign generated key material. Keep the master key secret and stable for keys that must remain valid over time.</p>
|
||||
<h2 id="subscribe-to-capykit-events">Subscribe To CapyKit Events</h2>
|
||||
<pre><code class="lang-csharp">using CapyKit;
|
||||
|
||||
CapyEventReporter.Subscribe(
|
||||
e => Console.WriteLine($"[{e.Level}] {e.MethodName}: {e.Message}"),
|
||||
EventLevel.Warning);
|
||||
</code></pre>
|
||||
<p>CapyKit does not require a logging framework. Subscribe to events and forward them to whatever logging or telemetry system your application already uses.</p>
|
||||
<h2 id="browse-the-api">Browse The API</h2>
|
||||
<p>For the full list of namespaces, types, overloads, and member signatures, open the generated <a href="api/toc.html">API Reference</a>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>CapyKit Documentation | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="CapyKit Documentation | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="landing" data-yaml-mime="">
|
||||
<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="">
|
||||
<h1 id="capykit-documentation">CapyKit Documentation</h1>
|
||||
|
||||
<p>CapyKit is a small .NET utility library for the code you end up writing repeatedly: collection helpers, string and enum extensions, JSON serialization, gzip compression, password hashing, random token generation, simple key validation, distance calculations, and lightweight event reporting.</p>
|
||||
<p>The library targets .NET 8 and keeps its public surface intentionally direct. Most features are static helpers or extension methods, so consuming projects can adopt one piece at a time without taking on a framework or application model.</p>
|
||||
<h2 id="start-here">Start Here</h2>
|
||||
<ul>
|
||||
<li><a href="introduction.html">Introduction</a> explains what CapyKit includes and how the namespaces are organized.</li>
|
||||
<li><a href="getting-started.html">Getting Started</a> shows installation, imports, and common usage examples.</li>
|
||||
<li><a href="api/CapyKit.html">API Reference</a> contains the generated DocFX reference for every public type and member.</li>
|
||||
</ul>
|
||||
<h2 id="common-tasks">Common Tasks</h2>
|
||||
<h3 id="work-with-strings-and-collections">Work with strings and collections</h3>
|
||||
<p>Use <code>CapyKit.Extensions</code> for small quality-of-life helpers such as null fallback values, pagination, inverted filtering, left outer joins, enum display names, and property copying.</p>
|
||||
<pre><code class="lang-csharp">using CapyKit.Extensions;
|
||||
|
||||
var displayName = user.Name.IfNullOrWhiteSpace("Guest");
|
||||
var page = users.Page(pageNumber: 2, pageSize: 25);
|
||||
</code></pre>
|
||||
<h3 id="serialize-compress-and-restore-values">Serialize, compress, and restore values</h3>
|
||||
<p>Use <code>CapyKit.Helpers.SerializationHelper</code> and <code>CapyKit.Helpers.CompressionHelper</code> when you need straightforward JSON serialization or gzip compression around serializable values.</p>
|
||||
<pre><code class="lang-csharp">using CapyKit.Helpers;
|
||||
|
||||
var payload = SerializationHelper.SerializeToString(order);
|
||||
var compressed = CompressionHelper.CompressToString(order);
|
||||
var restored = CompressionHelper.Decompress<Order>(compressed);
|
||||
</code></pre>
|
||||
<h3 id="hash-passwords-and-generate-tokens">Hash passwords and generate tokens</h3>
|
||||
<p>Use <code>SecurityHelper</code> for PBKDF2 password hashes, salts, and random values backed by .NET cryptographic random number generation.</p>
|
||||
<pre><code class="lang-csharp">using CapyKit;
|
||||
using CapyKit.Helpers;
|
||||
|
||||
Password password = SecurityHelper.Pbkdf2("correct horse battery staple");
|
||||
bool matches = SecurityHelper.CompareHashedPassword(
|
||||
password,
|
||||
"correct horse battery staple",
|
||||
password.Salt,
|
||||
Password.Pbkdf2Algorithm);
|
||||
</code></pre>
|
||||
<h3 id="listen-to-capykit-events">Listen to CapyKit events</h3>
|
||||
<p>CapyKit reports warnings and errors through <code>CapyEventReporter</code> instead of choosing a logging framework for you. Subscribe at the level your application cares about and route events into your own logging pipeline.</p>
|
||||
<pre><code class="lang-csharp">using CapyKit;
|
||||
|
||||
CapyEventReporter.Subscribe(
|
||||
e => logger.LogWarning("{Method}: {Message}", e.MethodName, e.Message),
|
||||
EventLevel.Warning);
|
||||
</code></pre>
|
||||
<h2 id="build-the-docs-locally">Build The Docs Locally</h2>
|
||||
<p>The documentation is generated with DocFX from the Markdown files in this folder and the XML comments in the <code>CapyKit</code> project.</p>
|
||||
<pre><code class="lang-bash">dotnet tool install -g docfx
|
||||
docfx Docs/docfx.json --serve
|
||||
</code></pre>
|
||||
<p>DocFX writes the generated site to <code>Docs/_site</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,136 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Introduction | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Introduction | 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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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="">
|
||||
<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="">
|
||||
<h1 id="introduction">Introduction</h1>
|
||||
|
||||
<p>CapyKit is a practical toolkit for .NET applications. It collects common helpers and extension methods into one package so application code can stay focused on business behavior instead of re-implementing the same plumbing in every project.</p>
|
||||
<p>The project began as shared infrastructure for HappyCapy and is now available as a standalone library. It currently targets .NET 8.</p>
|
||||
<h2 id="what-capykit-provides">What CapyKit Provides</h2>
|
||||
<h3 id="extension-methods">Extension Methods</h3>
|
||||
<p>The <code>CapyKit.Extensions</code> namespace contains helpers for common language and LINQ tasks:</p>
|
||||
<ul>
|
||||
<li><code>StringExtensions</code> provides fallback helpers such as <code>IfNullOrEmpty</code> and <code>IfNullOrWhiteSpace</code>.</li>
|
||||
<li><code>LINQExtensions</code> adds pagination, page counts, inverted filtering, and left outer join helpers for enumerable and queryable collections.</li>
|
||||
<li><code>EnumerationExtensions</code> makes enum names, numeric values, descriptions, and human-readable names easier to retrieve.</li>
|
||||
<li><code>ObjectExtensions</code> copies matching writable properties from one object to another.</li>
|
||||
</ul>
|
||||
<h3 id="helper-classes">Helper Classes</h3>
|
||||
<p>The <code>CapyKit.Helpers</code> namespace contains focused utility classes:</p>
|
||||
<ul>
|
||||
<li><code>SerializationHelper</code> serializes and deserializes values with <code>System.Text.Json</code>.</li>
|
||||
<li><code>CompressionHelper</code> compresses serialized values with gzip and can represent compressed data as Base64.</li>
|
||||
<li><code>SecurityHelper</code> creates PBKDF2 password hashes, salts, random strings, and random passwords.</li>
|
||||
<li><code>KeyHelper</code> creates and validates formatted HMAC-backed keys using a caller-provided master key.</li>
|
||||
<li><code>CalculationHelper</code> includes distance calculations, unit conversion, angle conversion, and quick non-cryptographic hash helpers.</li>
|
||||
<li><code>LanguageHelper</code> converts camel case identifiers into human-readable text.</li>
|
||||
</ul>
|
||||
<h3 id="core-utility-types">Core Utility Types</h3>
|
||||
<p>The root <code>CapyKit</code> namespace includes small types that support the helpers:</p>
|
||||
<ul>
|
||||
<li><code>Password</code>, <code>IPasswordAlgorithm</code>, and <code>Pbkdf2Algorithm</code> model password hashing.</li>
|
||||
<li><code>Pool<T></code> and <code>PoolItem<T></code> provide a simple resource pool abstraction.</li>
|
||||
<li><code>PropertyComparer<T, U></code> compares objects by a selected property.</li>
|
||||
<li><code>CapyEventReporter</code>, <code>CapyEventArgs</code>, and <code>EventLevel</code> expose library diagnostics without requiring a specific logging package.</li>
|
||||
<li><code>NamedColor</code> provides a large named color enumeration based on the XKCD color survey palette.</li>
|
||||
</ul>
|
||||
<h2 id="design-approach">Design Approach</h2>
|
||||
<p>CapyKit favors explicit, discoverable APIs. Most helpers are static methods or extension methods and can be adopted independently. You can use only the namespaces you need, and the library does not impose dependency injection, hosting, logging, or configuration conventions on the consuming application.</p>
|
||||
<p>Where CapyKit needs to communicate warnings or errors internally, it uses <code>CapyEventReporter</code>. Applications can subscribe to these events and map them into their preferred logging, telemetry, or diagnostics system.</p>
|
||||
<h2 id="api-reference">API Reference</h2>
|
||||
<p>The generated API reference is available through the DocFX navigation and starts at <a href="api/toc.html">API Reference</a>. Use it for exact signatures, overloads, return types, exceptions, and XML comment details.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
|
||||
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
|
||||
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
|
||||
width="38.000000pt" height="38.000000pt" viewBox="0 0 172.000000 172.000000"
|
||||
preserveAspectRatio="xMidYMid meet">
|
||||
<metadata>
|
||||
Created by Docfx
|
||||
</metadata>
|
||||
<g transform="translate(0.000000,172.000000) scale(0.100000,-0.100000)"
|
||||
fill="#dddddd" stroke="none">
|
||||
<path d="M230 1359 c0 -18 11 -30 44 -48 80 -42 81 -45 81 -441 0 -400 -1
|
||||
-404 -79 -436 -36 -15 -46 -24 -46 -43 0 -23 2 -24 61 -17 34 3 88 6 120 6
|
||||
l59 0 0 495 0 495 -82 0 c-46 0 -100 3 -120 6 -35 6 -38 5 -38 -17z"/>
|
||||
<path d="M618 1373 l-118 -4 0 -493 0 -494 154 -7 c181 -9 235 -3 313 34 68
|
||||
33 168 130 207 202 75 136 75 384 1 536 -71 145 -234 240 -399 231 -23 -1 -94
|
||||
-4 -158 -5z m287 -119 c68 -24 144 -101 176 -179 22 -54 24 -75 24 -210 0
|
||||
-141 -2 -153 -26 -206 -36 -76 -89 -132 -152 -160 -45 -21 -68 -24 -164 -24
|
||||
-71 0 -116 4 -123 11 -22 22 -31 175 -28 463 2 208 6 293 15 302 32 32 188 33
|
||||
278 3z"/>
|
||||
<path d="M1170 1228 c75 -104 110 -337 76 -508 -21 -100 -56 -178 -105 -233
|
||||
l-36 -41 34 20 c75 43 160 133 198 212 37 75 38 78 38 191 -1 129 -18 191 -75
|
||||
270 -28 38 -136 131 -153 131 -4 0 6 -19 23 -42z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.2 KiB |
|
|
@ -1,435 +0,0 @@
|
|||
{
|
||||
"source_base_path": "/home/jordanwages/Git/CapyKit/Docs",
|
||||
"xrefmap": "xrefmap.yml",
|
||||
"files": [
|
||||
{
|
||||
"type": "Resource",
|
||||
"output": {
|
||||
"resource": {
|
||||
"relative_path": "index.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.CapyEventArgs.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.CapyEventArgs.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.CapyEventHandler.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.CapyEventHandler.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.CapyEventReporter.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.CapyEventReporter.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Color.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Color.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.EncryptedValue-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.EncryptedValue-1.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Enumerations.MeasurementSystem.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Enumerations.MeasurementSystem.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Enumerations.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Enumerations.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.EventLevel.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.EventLevel.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.EnumerationExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.EnumerationExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.LINQExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.LINQExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.ObjectExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.ObjectExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.StringExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.StringExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.CalculationHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.CalculationHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.CompressionHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.CompressionHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.EncryptionHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.EncryptionHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.KeyHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.KeyHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.LanguageHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.LanguageHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SecurityHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.SecurityHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SerializationHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.SerializationHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SettingsHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.SettingsHelper.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.IPasswordAlgorithm.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.IPasswordAlgorithm.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.NamedColor.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.NamedColor.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Password.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Password.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Pbkdf2Algorithm.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Pbkdf2Algorithm.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Pool-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Pool-1.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.PoolItem-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.PoolItem-1.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.PropertyComparer-2.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.PropertyComparer-2.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Toc",
|
||||
"source_relative_path": "api/toc.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/toc.html"
|
||||
},
|
||||
".json": {
|
||||
"relative_path": "api/toc.json"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "getting-started.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "getting-started.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "index.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "index.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "introduction.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "introduction.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Toc",
|
||||
"source_relative_path": "toc.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "toc.html"
|
||||
},
|
||||
".json": {
|
||||
"relative_path": "toc.json"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
}
|
||||
],
|
||||
"groups": [
|
||||
{
|
||||
"xrefmap": "xrefmap.yml"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
import{a as e,b as r}from"./chunk-HC7FQI6W.min.js";import"./chunk-E24YF7OQ.min.js";import"./chunk-R5JLOOQ4.min.js";import"./chunk-PTL4EUOE.min.js";import"./chunk-E5F23VE2.min.js";import"./chunk-VBFLGJ4I.min.js";export{e as ArchitectureModule,r as createArchitectureServices};
|
||||
//# sourceMappingURL=architecture-7HQA4BMR-HSKY6TUH.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": [],
|
||||
"sourcesContent": [],
|
||||
"mappings": "",
|
||||
"names": []
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-2SNPQT3V.min.js
vendored
2
Docs/_site/public/chunk-2SNPQT3V.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{b as t}from"./chunk-4TS2OR5T.min.js";var s=class{constructor(i){this.init=i,this.records=this.init()}static{t(this,"ImperativeState")}reset(){this.records=this.init()}};export{s as a};
|
||||
//# sourceMappingURL=chunk-2SNPQT3V.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/chunks/mermaid.core/chunk-QZHKN3VN.mjs"],
|
||||
"sourcesContent": ["import {\n __name\n} from \"./chunk-AGHRB4JF.mjs\";\n\n// src/utils/imperativeState.ts\nvar ImperativeState = class {\n /**\n * @param init - Function that creates the default state.\n */\n constructor(init) {\n this.init = init;\n this.records = this.init();\n }\n static {\n __name(this, \"ImperativeState\");\n }\n reset() {\n this.records = this.init();\n }\n};\n\nexport {\n ImperativeState\n};\n"],
|
||||
"mappings": "4CAKA,IAAIA,EAAkB,KAAM,CAI1B,YAAYC,EAAM,CAChB,KAAK,KAAOA,EACZ,KAAK,QAAU,KAAK,KAAK,CAC3B,CACA,MAAO,CACLC,EAAO,KAAM,iBAAiB,CAChC,CACA,OAAQ,CACN,KAAK,QAAU,KAAK,KAAK,CAC3B,CACF",
|
||||
"names": ["ImperativeState", "init", "__name"]
|
||||
}
|
||||
8
Docs/_site/public/chunk-3EXUMIIG.min.js
vendored
8
Docs/_site/public/chunk-3EXUMIIG.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
71
Docs/_site/public/chunk-3INE33PR.min.js
vendored
71
Docs/_site/public/chunk-3INE33PR.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
22
Docs/_site/public/chunk-3OUT3TPH.min.js
vendored
22
Docs/_site/public/chunk-3OUT3TPH.min.js
vendored
|
|
@ -1,22 +0,0 @@
|
|||
import{b as k}from"./chunk-VBFLGJ4I.min.js";var v=k((h,j)=>{(function(e,n){typeof define=="function"&&define.amd?define(n):typeof h=="object"?j.exports=n():n()(e.lunr)})(h,function(){return function(e){if(typeof e>"u")throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(typeof e.stemmerSupport>"u")throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var n=e.version[0]=="2";e.ja=function(){this.pipeline.reset(),this.pipeline.add(e.ja.trimmer,e.ja.stopWordFilter,e.ja.stemmer),n?this.tokenizer=e.ja.tokenizer:(e.tokenizer&&(e.tokenizer=e.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.ja.tokenizer))};var F=new e.TinySegmenter;e.ja.tokenizer=function(s){var t,i,f,o,a,d,g,p,r,c;if(!arguments.length||s==null||s==null)return[];if(Array.isArray(s))return s.map(function(m){return n?new e.Token(m.toLowerCase()):m.toLowerCase()});for(i=s.toString().toLowerCase().replace(/^\s+/,""),t=i.length-1;t>=0;t--)if(/\S/.test(i.charAt(t))){i=i.substring(0,t+1);break}for(a=[],f=i.length,r=0,p=0;r<=f;r++)if(d=i.charAt(r),g=r-p,d.match(/\s/)||r==f){if(g>0)for(o=F.segment(i.slice(p,r)).filter(function(m){return!!m}),c=p,t=0;t<o.length;t++)n?a.push(new e.Token(o[t],{position:[c,o[t].length],index:a.length})):a.push(o[t]),c+=o[t].length;p=r+1}return a},e.ja.stemmer=(function(){return function(s){return s}})(),e.Pipeline.registerFunction(e.ja.stemmer,"stemmer-ja"),e.ja.wordCharacters="\u4E00\u4E8C\u4E09\u56DB\u4E94\u516D\u4E03\u516B\u4E5D\u5341\u767E\u5343\u4E07\u5104\u5146\u4E00-\u9FA0\u3005\u3006\u30F5\u30F6\u3041-\u3093\u30A1-\u30F4\u30FC\uFF71-\uFF9D\uFF9Ea-zA-Z\uFF41-\uFF5A\uFF21-\uFF3A0-9\uFF10-\uFF19",e.ja.trimmer=e.trimmerSupport.generateTrimmer(e.ja.wordCharacters),e.Pipeline.registerFunction(e.ja.trimmer,"trimmer-ja"),e.ja.stopWordFilter=e.generateStopWordFilter("\u3053\u308C \u305D\u308C \u3042\u308C \u3053\u306E \u305D\u306E \u3042\u306E \u3053\u3053 \u305D\u3053 \u3042\u305D\u3053 \u3053\u3061\u3089 \u3069\u3053 \u3060\u308C \u306A\u306B \u306A\u3093 \u4F55 \u79C1 \u8CB4\u65B9 \u8CB4\u65B9\u65B9 \u6211\u3005 \u79C1\u9054 \u3042\u306E\u4EBA \u3042\u306E\u304B\u305F \u5F7C\u5973 \u5F7C \u3067\u3059 \u3042\u308A\u307E\u3059 \u304A\u308A\u307E\u3059 \u3044\u307E\u3059 \u306F \u304C \u306E \u306B \u3092 \u3067 \u3048 \u304B\u3089 \u307E\u3067 \u3088\u308A \u3082 \u3069\u306E \u3068 \u3057 \u305D\u308C\u3067 \u3057\u304B\u3057".split(" ")),e.Pipeline.registerFunction(e.ja.stopWordFilter,"stopWordFilter-ja"),e.jp=e.ja,e.Pipeline.registerFunction(e.jp.stemmer,"stemmer-jp"),e.Pipeline.registerFunction(e.jp.trimmer,"trimmer-jp"),e.Pipeline.registerFunction(e.jp.stopWordFilter,"stopWordFilter-jp")}})});export{v as a};
|
||||
/*! Bundled license information:
|
||||
|
||||
lunr-languages/lunr.ja.js:
|
||||
(*!
|
||||
* Lunr languages, `Japanese` language
|
||||
* https://github.com/MihaiValentin/lunr-languages
|
||||
*
|
||||
* Copyright 2014, Chad Liu
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
(*!
|
||||
* based on
|
||||
* Snowball JavaScript Library v0.3
|
||||
* http://code.google.com/p/urim/
|
||||
* http://snowball.tartarus.org/
|
||||
*
|
||||
* Copyright 2010, Oleg Mazko
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
*/
|
||||
//# sourceMappingURL=chunk-3OUT3TPH.min.js.map
|
||||
File diff suppressed because one or more lines are too long
3
Docs/_site/public/chunk-4S6YPXQK.min.js
vendored
3
Docs/_site/public/chunk-4S6YPXQK.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-4TS2OR5T.min.js
vendored
2
Docs/_site/public/chunk-4TS2OR5T.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-54TWZ5TY.min.js
vendored
2
Docs/_site/public/chunk-54TWZ5TY.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
221
Docs/_site/public/chunk-A6K5RA3E.min.js
vendored
221
Docs/_site/public/chunk-A6K5RA3E.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-AJUMGIIP.min.js
vendored
2
Docs/_site/public/chunk-AJUMGIIP.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{a as n,b as s,c as i,d as l,e as f,f as o,g as d,n as m,o as c,q as p}from"./chunk-E24YF7OQ.min.js";var u=class extends p{static{o(this,"TreemapTokenBuilder")}constructor(){super(["treemap"])}},v=/classDef\s+([A-Z_a-z]\w+)(?:\s+([^\n\r;]*))?;?/,g=class extends c{static{o(this,"TreemapValueConverter")}runCustomConverter(r,e,t){if(r.name==="NUMBER2")return parseFloat(e.replace(/,/g,""));if(r.name==="SEPARATOR")return e.substring(1,e.length-1);if(r.name==="STRING2")return e.substring(1,e.length-1);if(r.name==="INDENTATION")return e.length;if(r.name==="ClassDef"){if(typeof e!="string")return e;let a=v.exec(e);if(a)return{$type:"ClassDefStatement",className:a[1],styleText:a[2]||void 0}}}};function T(r){let e=r.validation.TreemapValidator,t=r.validation.ValidationRegistry;if(t){let a={Treemap:e.checkSingleRoot.bind(e)};t.register(a,e)}}o(T,"registerValidationChecks");var h=class{static{o(this,"TreemapValidator")}checkSingleRoot(r,e){let t;for(let a of r.TreemapRows)a.item&&(t===void 0&&a.indent===void 0?t=0:a.indent===void 0?e("error","Multiple root nodes are not allowed in a treemap.",{node:a,property:"item"}):t!==void 0&&t>=parseInt(a.indent,10)&&e("error","Multiple root nodes are not allowed in a treemap.",{node:a,property:"item"}))}},C={parser:{TokenBuilder:o(()=>new u,"TokenBuilder"),ValueConverter:o(()=>new g,"ValueConverter")},validation:{TreemapValidator:o(()=>new h,"TreemapValidator")}};function V(r=l){let e=i(s(r),d),t=i(n({shared:e}),m,C);return e.ServiceRegistry.register(t),T(t),{shared:e,Treemap:t}}o(V,"createTreemapServices");export{C as a,V as b};
|
||||
//# sourceMappingURL=chunk-AJUMGIIP.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/@mermaid-js/parser/dist/chunks/mermaid-parser.core/chunk-B2363JML.mjs"],
|
||||
"sourcesContent": ["import {\n AbstractMermaidTokenBuilder,\n AbstractMermaidValueConverter,\n MermaidGeneratedSharedModule,\n TreemapGrammarGeneratedModule,\n __name\n} from \"./chunk-TCCFYFTB.mjs\";\n\n// src/language/treemap/module.ts\nimport {\n EmptyFileSystem,\n createDefaultCoreModule,\n createDefaultSharedCoreModule,\n inject\n} from \"langium\";\n\n// src/language/treemap/tokenBuilder.ts\nvar TreemapTokenBuilder = class extends AbstractMermaidTokenBuilder {\n static {\n __name(this, \"TreemapTokenBuilder\");\n }\n constructor() {\n super([\"treemap\"]);\n }\n};\n\n// src/language/treemap/valueConverter.ts\nvar classDefRegex = /classDef\\s+([A-Z_a-z]\\w+)(?:\\s+([^\\n\\r;]*))?;?/;\nvar TreemapValueConverter = class extends AbstractMermaidValueConverter {\n static {\n __name(this, \"TreemapValueConverter\");\n }\n runCustomConverter(rule, input, _cstNode) {\n if (rule.name === \"NUMBER2\") {\n return parseFloat(input.replace(/,/g, \"\"));\n } else if (rule.name === \"SEPARATOR\") {\n return input.substring(1, input.length - 1);\n } else if (rule.name === \"STRING2\") {\n return input.substring(1, input.length - 1);\n } else if (rule.name === \"INDENTATION\") {\n return input.length;\n } else if (rule.name === \"ClassDef\") {\n if (typeof input !== \"string\") {\n return input;\n }\n const match = classDefRegex.exec(input);\n if (match) {\n return {\n $type: \"ClassDefStatement\",\n className: match[1],\n styleText: match[2] || void 0\n };\n }\n }\n return void 0;\n }\n};\n\n// src/language/treemap/treemap-validator.ts\nfunction registerValidationChecks(services) {\n const validator = services.validation.TreemapValidator;\n const registry = services.validation.ValidationRegistry;\n if (registry) {\n const checks = {\n Treemap: validator.checkSingleRoot.bind(validator)\n // Remove unused validation for TreemapRow\n };\n registry.register(checks, validator);\n }\n}\n__name(registerValidationChecks, \"registerValidationChecks\");\nvar TreemapValidator = class {\n static {\n __name(this, \"TreemapValidator\");\n }\n /**\n * Validates that a treemap has only one root node.\n * A root node is defined as a node that has no indentation.\n */\n checkSingleRoot(doc, accept) {\n let rootNodeIndentation;\n for (const row of doc.TreemapRows) {\n if (!row.item) {\n continue;\n }\n if (rootNodeIndentation === void 0 && // Check if this is a root node (no indentation)\n row.indent === void 0) {\n rootNodeIndentation = 0;\n } else if (row.indent === void 0) {\n accept(\"error\", \"Multiple root nodes are not allowed in a treemap.\", {\n node: row,\n property: \"item\"\n });\n } else if (rootNodeIndentation !== void 0 && rootNodeIndentation >= parseInt(row.indent, 10)) {\n accept(\"error\", \"Multiple root nodes are not allowed in a treemap.\", {\n node: row,\n property: \"item\"\n });\n }\n }\n }\n};\n\n// src/language/treemap/module.ts\nvar TreemapModule = {\n parser: {\n TokenBuilder: /* @__PURE__ */ __name(() => new TreemapTokenBuilder(), \"TokenBuilder\"),\n ValueConverter: /* @__PURE__ */ __name(() => new TreemapValueConverter(), \"ValueConverter\")\n },\n validation: {\n TreemapValidator: /* @__PURE__ */ __name(() => new TreemapValidator(), \"TreemapValidator\")\n }\n};\nfunction createTreemapServices(context = EmptyFileSystem) {\n const shared = inject(\n createDefaultSharedCoreModule(context),\n MermaidGeneratedSharedModule\n );\n const Treemap = inject(\n createDefaultCoreModule({ shared }),\n TreemapGrammarGeneratedModule,\n TreemapModule\n );\n shared.ServiceRegistry.register(Treemap);\n registerValidationChecks(Treemap);\n return { shared, Treemap };\n}\n__name(createTreemapServices, \"createTreemapServices\");\n\nexport {\n TreemapModule,\n createTreemapServices\n};\n"],
|
||||
"mappings": "2GAiBA,IAAIA,EAAsB,cAAcC,CAA4B,CAClE,MAAO,CACLC,EAAO,KAAM,qBAAqB,CACpC,CACA,aAAc,CACZ,MAAM,CAAC,SAAS,CAAC,CACnB,CACF,EAGIC,EAAgB,iDAChBC,EAAwB,cAAcC,CAA8B,CACtE,MAAO,CACLH,EAAO,KAAM,uBAAuB,CACtC,CACA,mBAAmBI,EAAMC,EAAOC,EAAU,CACxC,GAAIF,EAAK,OAAS,UAChB,OAAO,WAAWC,EAAM,QAAQ,KAAM,EAAE,CAAC,EACpC,GAAID,EAAK,OAAS,YACvB,OAAOC,EAAM,UAAU,EAAGA,EAAM,OAAS,CAAC,EACrC,GAAID,EAAK,OAAS,UACvB,OAAOC,EAAM,UAAU,EAAGA,EAAM,OAAS,CAAC,EACrC,GAAID,EAAK,OAAS,cACvB,OAAOC,EAAM,OACR,GAAID,EAAK,OAAS,WAAY,CACnC,GAAI,OAAOC,GAAU,SACnB,OAAOA,EAET,IAAME,EAAQN,EAAc,KAAKI,CAAK,EACtC,GAAIE,EACF,MAAO,CACL,MAAO,oBACP,UAAWA,EAAM,CAAC,EAClB,UAAWA,EAAM,CAAC,GAAK,MACzB,CAEJ,CAEF,CACF,EAGA,SAASC,EAAyBC,EAAU,CAC1C,IAAMC,EAAYD,EAAS,WAAW,iBAChCE,EAAWF,EAAS,WAAW,mBACrC,GAAIE,EAAU,CACZ,IAAMC,EAAS,CACb,QAASF,EAAU,gBAAgB,KAAKA,CAAS,CAEnD,EACAC,EAAS,SAASC,EAAQF,CAAS,CACrC,CACF,CACAV,EAAOQ,EAA0B,0BAA0B,EAC3D,IAAIK,EAAmB,KAAM,CAC3B,MAAO,CACLb,EAAO,KAAM,kBAAkB,CACjC,CAKA,gBAAgBc,EAAKC,EAAQ,CAC3B,IAAIC,EACJ,QAAWC,KAAOH,EAAI,YACfG,EAAI,OAGLD,IAAwB,QAC5BC,EAAI,SAAW,OACbD,EAAsB,EACbC,EAAI,SAAW,OACxBF,EAAO,QAAS,oDAAqD,CACnE,KAAME,EACN,SAAU,MACZ,CAAC,EACQD,IAAwB,QAAUA,GAAuB,SAASC,EAAI,OAAQ,EAAE,GACzFF,EAAO,QAAS,oDAAqD,CACnE,KAAME,EACN,SAAU,MACZ,CAAC,EAGP,CACF,EAGIC,EAAgB,CAClB,OAAQ,CACN,aAA8BlB,EAAO,IAAM,IAAIF,EAAuB,cAAc,EACpF,eAAgCE,EAAO,IAAM,IAAIE,EAAyB,gBAAgB,CAC5F,EACA,WAAY,CACV,iBAAkCF,EAAO,IAAM,IAAIa,EAAoB,kBAAkB,CAC3F,CACF,EACA,SAASM,EAAsBC,EAAUC,EAAiB,CACxD,IAAMC,EAASC,EACbC,EAA8BJ,CAAO,EACrCK,CACF,EACMC,EAAUH,EACdI,EAAwB,CAAE,OAAAL,CAAO,CAAC,EAClCM,EACAV,CACF,EACA,OAAAI,EAAO,gBAAgB,SAASI,CAAO,EACvClB,EAAyBkB,CAAO,EACzB,CAAE,OAAAJ,EAAQ,QAAAI,CAAQ,CAC3B,CACA1B,EAAOmB,EAAuB,uBAAuB",
|
||||
"names": ["TreemapTokenBuilder", "AbstractMermaidTokenBuilder", "__name", "classDefRegex", "TreemapValueConverter", "AbstractMermaidValueConverter", "rule", "input", "_cstNode", "match", "registerValidationChecks", "services", "validator", "registry", "checks", "TreemapValidator", "doc", "accept", "rootNodeIndentation", "row", "TreemapModule", "createTreemapServices", "context", "EmptyFileSystem", "shared", "inject", "createDefaultSharedCoreModule", "MermaidGeneratedSharedModule", "Treemap", "createDefaultCoreModule", "TreemapGrammarGeneratedModule"]
|
||||
}
|
||||
160
Docs/_site/public/chunk-E24YF7OQ.min.js
vendored
160
Docs/_site/public/chunk-E24YF7OQ.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-E5F23VE2.min.js
vendored
2
Docs/_site/public/chunk-E5F23VE2.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-EEHY3DYQ.min.js
vendored
2
Docs/_site/public/chunk-EEHY3DYQ.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{W as s}from"./chunk-ETRULKCA.min.js";import{b as n,j as e}from"./chunk-4TS2OR5T.min.js";var a=n(t=>{let{securityLevel:c}=s(),o=e("body");if(c==="sandbox"){let m=e(`#i${t}`).node()?.contentDocument??document;o=e(m.body)}return o.select(`#${t}`)},"selectSvgElement");export{a};
|
||||
//# sourceMappingURL=chunk-EEHY3DYQ.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/chunks/mermaid.core/chunk-EXTU4WIE.mjs"],
|
||||
"sourcesContent": ["import {\n getConfig2 as getConfig\n} from \"./chunk-ABZYJK2D.mjs\";\nimport {\n __name\n} from \"./chunk-AGHRB4JF.mjs\";\n\n// src/rendering-util/selectSvgElement.ts\nimport { select } from \"d3\";\nvar selectSvgElement = /* @__PURE__ */ __name((id) => {\n const { securityLevel } = getConfig();\n let root = select(\"body\");\n if (securityLevel === \"sandbox\") {\n const sandboxElement = select(`#i${id}`);\n const doc = sandboxElement.node()?.contentDocument ?? document;\n root = select(doc.body);\n }\n const svg = root.select(`#${id}`);\n return svg;\n}, \"selectSvgElement\");\n\nexport {\n selectSvgElement\n};\n"],
|
||||
"mappings": "+FASA,IAAIA,EAAmCC,EAAQC,GAAO,CACpD,GAAM,CAAE,cAAAC,CAAc,EAAIC,EAAU,EAChCC,EAAOC,EAAO,MAAM,EACxB,GAAIH,IAAkB,UAAW,CAE/B,IAAMI,EADiBD,EAAO,KAAKJ,CAAE,EAAE,EACZ,KAAK,GAAG,iBAAmB,SACtDG,EAAOC,EAAOC,EAAI,IAAI,CACxB,CAEA,OADYF,EAAK,OAAO,IAAIH,CAAE,EAAE,CAElC,EAAG,kBAAkB",
|
||||
"names": ["selectSvgElement", "__name", "id", "securityLevel", "getConfig2", "root", "select_default", "doc"]
|
||||
}
|
||||
86
Docs/_site/public/chunk-ETRULKCA.min.js
vendored
86
Docs/_site/public/chunk-ETRULKCA.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-FMXZD665.min.js
vendored
2
Docs/_site/public/chunk-FMXZD665.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{b as i}from"./chunk-4TS2OR5T.min.js";var o=i(({flowchart:t})=>{let r=t?.subGraphTitleMargin?.top??0,a=t?.subGraphTitleMargin?.bottom??0,e=r+a;return{subGraphTitleTopMargin:r,subGraphTitleBottomMargin:a,subGraphTitleTotalMargin:e}},"getSubGraphTitleMargins");export{o as a};
|
||||
//# sourceMappingURL=chunk-FMXZD665.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/chunks/mermaid.core/chunk-CVBHYZKI.mjs"],
|
||||
"sourcesContent": ["import {\n __name\n} from \"./chunk-AGHRB4JF.mjs\";\n\n// src/utils/subGraphTitleMargins.ts\nvar getSubGraphTitleMargins = /* @__PURE__ */ __name(({\n flowchart\n}) => {\n const subGraphTitleTopMargin = flowchart?.subGraphTitleMargin?.top ?? 0;\n const subGraphTitleBottomMargin = flowchart?.subGraphTitleMargin?.bottom ?? 0;\n const subGraphTitleTotalMargin = subGraphTitleTopMargin + subGraphTitleBottomMargin;\n return {\n subGraphTitleTopMargin,\n subGraphTitleBottomMargin,\n subGraphTitleTotalMargin\n };\n}, \"getSubGraphTitleMargins\");\n\nexport {\n getSubGraphTitleMargins\n};\n"],
|
||||
"mappings": "4CAKA,IAAIA,EAA0CC,EAAO,CAAC,CACpD,UAAAC,CACF,IAAM,CACJ,IAAMC,EAAyBD,GAAW,qBAAqB,KAAO,EAChEE,EAA4BF,GAAW,qBAAqB,QAAU,EACtEG,EAA2BF,EAAyBC,EAC1D,MAAO,CACL,uBAAAD,EACA,0BAAAC,EACA,yBAAAC,CACF,CACF,EAAG,yBAAyB",
|
||||
"names": ["getSubGraphTitleMargins", "__name", "flowchart", "subGraphTitleTopMargin", "subGraphTitleBottomMargin", "subGraphTitleTotalMargin"]
|
||||
}
|
||||
2
Docs/_site/public/chunk-GK7N7244.min.js
vendored
2
Docs/_site/public/chunk-GK7N7244.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{b as m}from"./chunk-VBFLGJ4I.min.js";var R=m(e=>{"use strict";Object.defineProperty(e,"__esModule",{value:!0});e.BLANK_URL=e.relativeFirstCharacters=e.whitespaceEscapeCharsRegex=e.urlSchemeRegex=e.ctrlCharactersRegex=e.htmlCtrlEntityRegex=e.htmlEntitiesRegex=e.invalidProtocolRegex=void 0;e.invalidProtocolRegex=/^([^\w]*)(javascript|data|vbscript)/im;e.htmlEntitiesRegex=/&#(\w+)(^\w|;)?/g;e.htmlCtrlEntityRegex=/&(newline|tab);/gi;e.ctrlCharactersRegex=/[\u0000-\u001F\u007F-\u009F\u2000-\u200D\uFEFF]/gim;e.urlSchemeRegex=/^.+(:|:)/gim;e.whitespaceEscapeCharsRegex=/(\\|%5[cC])((%(6[eE]|72|74))|[nrt])/g;e.relativeFirstCharacters=[".","/"];e.BLANK_URL="about:blank"});var p=m(s=>{"use strict";Object.defineProperty(s,"__esModule",{value:!0});s.sanitizeUrl=void 0;var t=R();function d(r){return t.relativeFirstCharacters.indexOf(r[0])>-1}function v(r){var c=r.replace(t.ctrlCharactersRegex,"");return c.replace(t.htmlEntitiesRegex,function(a,i){return String.fromCharCode(i)})}function x(r){return URL.canParse(r)}function g(r){try{return decodeURIComponent(r)}catch{return r}}function C(r){if(!r)return t.BLANK_URL;var c,a=g(r.trim());do a=v(a).replace(t.htmlCtrlEntityRegex,"").replace(t.ctrlCharactersRegex,"").replace(t.whitespaceEscapeCharsRegex,"").trim(),a=g(a),c=a.match(t.ctrlCharactersRegex)||a.match(t.htmlEntitiesRegex)||a.match(t.htmlCtrlEntityRegex)||a.match(t.whitespaceEscapeCharsRegex);while(c&&c.length>0);var i=a;if(!i)return t.BLANK_URL;if(d(i))return i;var h=i.trimStart(),u=h.match(t.urlSchemeRegex);if(!u)return i;var n=u[0].toLowerCase().trim();if(t.invalidProtocolRegex.test(n))return t.BLANK_URL;var o=h.replace(/\\/g,"/");if(n==="mailto:"||n.includes("://"))return o;if(n==="http:"||n==="https:"){if(!x(o))return t.BLANK_URL;var l=new URL(o);return l.protocol=l.protocol.toLowerCase(),l.hostname=l.hostname.toLowerCase(),l.toString()}return o}s.sanitizeUrl=C});export{p as a};
|
||||
//# sourceMappingURL=chunk-GK7N7244.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/@braintree/sanitize-url/dist/constants.js", "../../node_modules/@braintree/sanitize-url/dist/index.js"],
|
||||
"sourcesContent": ["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.BLANK_URL = exports.relativeFirstCharacters = exports.whitespaceEscapeCharsRegex = exports.urlSchemeRegex = exports.ctrlCharactersRegex = exports.htmlCtrlEntityRegex = exports.htmlEntitiesRegex = exports.invalidProtocolRegex = void 0;\nexports.invalidProtocolRegex = /^([^\\w]*)(javascript|data|vbscript)/im;\nexports.htmlEntitiesRegex = /&#(\\w+)(^\\w|;)?/g;\nexports.htmlCtrlEntityRegex = /&(newline|tab);/gi;\nexports.ctrlCharactersRegex = /[\\u0000-\\u001F\\u007F-\\u009F\\u2000-\\u200D\\uFEFF]/gim;\nexports.urlSchemeRegex = /^.+(:|:)/gim;\nexports.whitespaceEscapeCharsRegex = /(\\\\|%5[cC])((%(6[eE]|72|74))|[nrt])/g;\nexports.relativeFirstCharacters = [\".\", \"/\"];\nexports.BLANK_URL = \"about:blank\";\n", "\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.sanitizeUrl = void 0;\nvar constants_1 = require(\"./constants\");\nfunction isRelativeUrlWithoutProtocol(url) {\n return constants_1.relativeFirstCharacters.indexOf(url[0]) > -1;\n}\nfunction decodeHtmlCharacters(str) {\n var removedNullByte = str.replace(constants_1.ctrlCharactersRegex, \"\");\n return removedNullByte.replace(constants_1.htmlEntitiesRegex, function (match, dec) {\n return String.fromCharCode(dec);\n });\n}\nfunction isValidUrl(url) {\n return URL.canParse(url);\n}\nfunction decodeURI(uri) {\n try {\n return decodeURIComponent(uri);\n }\n catch (e) {\n // Ignoring error\n // It is possible that the URI contains a `%` not associated\n // with URI/URL-encoding.\n return uri;\n }\n}\nfunction sanitizeUrl(url) {\n if (!url) {\n return constants_1.BLANK_URL;\n }\n var charsToDecode;\n var decodedUrl = decodeURI(url.trim());\n do {\n decodedUrl = decodeHtmlCharacters(decodedUrl)\n .replace(constants_1.htmlCtrlEntityRegex, \"\")\n .replace(constants_1.ctrlCharactersRegex, \"\")\n .replace(constants_1.whitespaceEscapeCharsRegex, \"\")\n .trim();\n decodedUrl = decodeURI(decodedUrl);\n charsToDecode =\n decodedUrl.match(constants_1.ctrlCharactersRegex) ||\n decodedUrl.match(constants_1.htmlEntitiesRegex) ||\n decodedUrl.match(constants_1.htmlCtrlEntityRegex) ||\n decodedUrl.match(constants_1.whitespaceEscapeCharsRegex);\n } while (charsToDecode && charsToDecode.length > 0);\n var sanitizedUrl = decodedUrl;\n if (!sanitizedUrl) {\n return constants_1.BLANK_URL;\n }\n if (isRelativeUrlWithoutProtocol(sanitizedUrl)) {\n return sanitizedUrl;\n }\n // Remove any leading whitespace before checking the URL scheme\n var trimmedUrl = sanitizedUrl.trimStart();\n var urlSchemeParseResults = trimmedUrl.match(constants_1.urlSchemeRegex);\n if (!urlSchemeParseResults) {\n return sanitizedUrl;\n }\n var urlScheme = urlSchemeParseResults[0].toLowerCase().trim();\n if (constants_1.invalidProtocolRegex.test(urlScheme)) {\n return constants_1.BLANK_URL;\n }\n var backSanitized = trimmedUrl.replace(/\\\\/g, \"/\");\n // Handle special cases for mailto: and custom deep-link protocols\n if (urlScheme === \"mailto:\" || urlScheme.includes(\"://\")) {\n return backSanitized;\n }\n // For http and https URLs, perform additional validation\n if (urlScheme === \"http:\" || urlScheme === \"https:\") {\n if (!isValidUrl(backSanitized)) {\n return constants_1.BLANK_URL;\n }\n var url_1 = new URL(backSanitized);\n url_1.protocol = url_1.protocol.toLowerCase();\n url_1.hostname = url_1.hostname.toLowerCase();\n return url_1.toString();\n }\n return backSanitized;\n}\nexports.sanitizeUrl = sanitizeUrl;\n"],
|
||||
"mappings": "4CAAA,IAAAA,EAAAC,EAAAC,GAAA,cACA,OAAO,eAAeA,EAAS,aAAc,CAAE,MAAO,EAAK,CAAC,EAC5DA,EAAQ,UAAYA,EAAQ,wBAA0BA,EAAQ,2BAA6BA,EAAQ,eAAiBA,EAAQ,oBAAsBA,EAAQ,oBAAsBA,EAAQ,kBAAoBA,EAAQ,qBAAuB,OAC3OA,EAAQ,qBAAuB,wCAC/BA,EAAQ,kBAAoB,mBAC5BA,EAAQ,oBAAsB,oBAC9BA,EAAQ,oBAAsB,qDAC9BA,EAAQ,eAAiB,oBACzBA,EAAQ,2BAA6B,uCACrCA,EAAQ,wBAA0B,CAAC,IAAK,GAAG,EAC3CA,EAAQ,UAAY,gBCVpB,IAAAC,EAAAC,EAAAC,GAAA,cACA,OAAO,eAAeA,EAAS,aAAc,CAAE,MAAO,EAAK,CAAC,EAC5DA,EAAQ,YAAc,OACtB,IAAIC,EAAc,IAClB,SAASC,EAA6BC,EAAK,CACvC,OAAOF,EAAY,wBAAwB,QAAQE,EAAI,CAAC,CAAC,EAAI,EACjE,CACA,SAASC,EAAqBC,EAAK,CAC/B,IAAIC,EAAkBD,EAAI,QAAQJ,EAAY,oBAAqB,EAAE,EACrE,OAAOK,EAAgB,QAAQL,EAAY,kBAAmB,SAAUM,EAAOC,EAAK,CAChF,OAAO,OAAO,aAAaA,CAAG,CAClC,CAAC,CACL,CACA,SAASC,EAAWN,EAAK,CACrB,OAAO,IAAI,SAASA,CAAG,CAC3B,CACA,SAASO,EAAUC,EAAK,CACpB,GAAI,CACA,OAAO,mBAAmBA,CAAG,CACjC,MACU,CAIN,OAAOA,CACX,CACJ,CACA,SAASC,EAAYT,EAAK,CACtB,GAAI,CAACA,EACD,OAAOF,EAAY,UAEvB,IAAIY,EACAC,EAAaJ,EAAUP,EAAI,KAAK,CAAC,EACrC,GACIW,EAAaV,EAAqBU,CAAU,EACvC,QAAQb,EAAY,oBAAqB,EAAE,EAC3C,QAAQA,EAAY,oBAAqB,EAAE,EAC3C,QAAQA,EAAY,2BAA4B,EAAE,EAClD,KAAK,EACVa,EAAaJ,EAAUI,CAAU,EACjCD,EACIC,EAAW,MAAMb,EAAY,mBAAmB,GAC5Ca,EAAW,MAAMb,EAAY,iBAAiB,GAC9Ca,EAAW,MAAMb,EAAY,mBAAmB,GAChDa,EAAW,MAAMb,EAAY,0BAA0B,QAC1DY,GAAiBA,EAAc,OAAS,GACjD,IAAIE,EAAeD,EACnB,GAAI,CAACC,EACD,OAAOd,EAAY,UAEvB,GAAIC,EAA6Ba,CAAY,EACzC,OAAOA,EAGX,IAAIC,EAAaD,EAAa,UAAU,EACpCE,EAAwBD,EAAW,MAAMf,EAAY,cAAc,EACvE,GAAI,CAACgB,EACD,OAAOF,EAEX,IAAIG,EAAYD,EAAsB,CAAC,EAAE,YAAY,EAAE,KAAK,EAC5D,GAAIhB,EAAY,qBAAqB,KAAKiB,CAAS,EAC/C,OAAOjB,EAAY,UAEvB,IAAIkB,EAAgBH,EAAW,QAAQ,MAAO,GAAG,EAEjD,GAAIE,IAAc,WAAaA,EAAU,SAAS,KAAK,EACnD,OAAOC,EAGX,GAAID,IAAc,SAAWA,IAAc,SAAU,CACjD,GAAI,CAACT,EAAWU,CAAa,EACzB,OAAOlB,EAAY,UAEvB,IAAImB,EAAQ,IAAI,IAAID,CAAa,EACjC,OAAAC,EAAM,SAAWA,EAAM,SAAS,YAAY,EAC5CA,EAAM,SAAWA,EAAM,SAAS,YAAY,EACrCA,EAAM,SAAS,CAC1B,CACA,OAAOD,CACX,CACAnB,EAAQ,YAAcY",
|
||||
"names": ["require_constants", "__commonJSMin", "exports", "require_dist", "__commonJSMin", "exports", "constants_1", "isRelativeUrlWithoutProtocol", "url", "decodeHtmlCharacters", "str", "removedNullByte", "match", "dec", "isValidUrl", "decodeURI", "uri", "sanitizeUrl", "charsToDecode", "decodedUrl", "sanitizedUrl", "trimmedUrl", "urlSchemeParseResults", "urlScheme", "backSanitized", "url_1"]
|
||||
}
|
||||
2
Docs/_site/public/chunk-HC7FQI6W.min.js
vendored
2
Docs/_site/public/chunk-HC7FQI6W.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{a as i,b as u,c as a,d as n,e as m,f as r,g as o,h as s,o as l,q as d}from"./chunk-E24YF7OQ.min.js";var h=class extends d{static{r(this,"ArchitectureTokenBuilder")}constructor(){super(["architecture"])}},A=class extends l{static{r(this,"ArchitectureValueConverter")}runCustomConverter(t,e,c){if(t.name==="ARCH_ICON")return e.replace(/[()]/g,"").trim();if(t.name==="ARCH_TEXT_ICON")return e.replace(/["()]/g,"");if(t.name==="ARCH_TITLE")return e.replace(/[[\]]/g,"").trim()}},C={parser:{TokenBuilder:r(()=>new h,"TokenBuilder"),ValueConverter:r(()=>new A,"ValueConverter")}};function v(t=n){let e=a(u(t),o),c=a(i({shared:e}),s,C);return e.ServiceRegistry.register(c),{shared:e,Architecture:c}}r(v,"createArchitectureServices");export{C as a,v as b};
|
||||
//# sourceMappingURL=chunk-HC7FQI6W.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/@mermaid-js/parser/dist/chunks/mermaid-parser.core/chunk-UMXZTB3W.mjs"],
|
||||
"sourcesContent": ["import {\n AbstractMermaidTokenBuilder,\n AbstractMermaidValueConverter,\n ArchitectureGrammarGeneratedModule,\n MermaidGeneratedSharedModule,\n __name\n} from \"./chunk-TCCFYFTB.mjs\";\n\n// src/language/architecture/module.ts\nimport {\n EmptyFileSystem,\n createDefaultCoreModule,\n createDefaultSharedCoreModule,\n inject\n} from \"langium\";\n\n// src/language/architecture/tokenBuilder.ts\nvar ArchitectureTokenBuilder = class extends AbstractMermaidTokenBuilder {\n static {\n __name(this, \"ArchitectureTokenBuilder\");\n }\n constructor() {\n super([\"architecture\"]);\n }\n};\n\n// src/language/architecture/valueConverter.ts\nvar ArchitectureValueConverter = class extends AbstractMermaidValueConverter {\n static {\n __name(this, \"ArchitectureValueConverter\");\n }\n runCustomConverter(rule, input, _cstNode) {\n if (rule.name === \"ARCH_ICON\") {\n return input.replace(/[()]/g, \"\").trim();\n } else if (rule.name === \"ARCH_TEXT_ICON\") {\n return input.replace(/[\"()]/g, \"\");\n } else if (rule.name === \"ARCH_TITLE\") {\n return input.replace(/[[\\]]/g, \"\").trim();\n }\n return void 0;\n }\n};\n\n// src/language/architecture/module.ts\nvar ArchitectureModule = {\n parser: {\n TokenBuilder: /* @__PURE__ */ __name(() => new ArchitectureTokenBuilder(), \"TokenBuilder\"),\n ValueConverter: /* @__PURE__ */ __name(() => new ArchitectureValueConverter(), \"ValueConverter\")\n }\n};\nfunction createArchitectureServices(context = EmptyFileSystem) {\n const shared = inject(\n createDefaultSharedCoreModule(context),\n MermaidGeneratedSharedModule\n );\n const Architecture = inject(\n createDefaultCoreModule({ shared }),\n ArchitectureGrammarGeneratedModule,\n ArchitectureModule\n );\n shared.ServiceRegistry.register(Architecture);\n return { shared, Architecture };\n}\n__name(createArchitectureServices, \"createArchitectureServices\");\n\nexport {\n ArchitectureModule,\n createArchitectureServices\n};\n"],
|
||||
"mappings": "2GAiBA,IAAIA,EAA2B,cAAcC,CAA4B,CACvE,MAAO,CACLC,EAAO,KAAM,0BAA0B,CACzC,CACA,aAAc,CACZ,MAAM,CAAC,cAAc,CAAC,CACxB,CACF,EAGIC,EAA6B,cAAcC,CAA8B,CAC3E,MAAO,CACLF,EAAO,KAAM,4BAA4B,CAC3C,CACA,mBAAmBG,EAAMC,EAAOC,EAAU,CACxC,GAAIF,EAAK,OAAS,YAChB,OAAOC,EAAM,QAAQ,QAAS,EAAE,EAAE,KAAK,EAClC,GAAID,EAAK,OAAS,iBACvB,OAAOC,EAAM,QAAQ,SAAU,EAAE,EAC5B,GAAID,EAAK,OAAS,aACvB,OAAOC,EAAM,QAAQ,SAAU,EAAE,EAAE,KAAK,CAG5C,CACF,EAGIE,EAAqB,CACvB,OAAQ,CACN,aAA8BN,EAAO,IAAM,IAAIF,EAA4B,cAAc,EACzF,eAAgCE,EAAO,IAAM,IAAIC,EAA8B,gBAAgB,CACjG,CACF,EACA,SAASM,EAA2BC,EAAUC,EAAiB,CAC7D,IAAMC,EAASC,EACbC,EAA8BJ,CAAO,EACrCK,CACF,EACMC,EAAeH,EACnBI,EAAwB,CAAE,OAAAL,CAAO,CAAC,EAClCM,EACAV,CACF,EACA,OAAAI,EAAO,gBAAgB,SAASI,CAAY,EACrC,CAAE,OAAAJ,EAAQ,aAAAI,CAAa,CAChC,CACAd,EAAOO,EAA4B,4BAA4B",
|
||||
"names": ["ArchitectureTokenBuilder", "AbstractMermaidTokenBuilder", "__name", "ArchitectureValueConverter", "AbstractMermaidValueConverter", "rule", "input", "_cstNode", "ArchitectureModule", "createArchitectureServices", "context", "EmptyFileSystem", "shared", "inject", "createDefaultSharedCoreModule", "MermaidGeneratedSharedModule", "Architecture", "createDefaultCoreModule", "ArchitectureGrammarGeneratedModule"]
|
||||
}
|
||||
166
Docs/_site/public/chunk-JVHSDEBR.min.js
vendored
166
Docs/_site/public/chunk-JVHSDEBR.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-LZQT2EPB.min.js
vendored
2
Docs/_site/public/chunk-LZQT2EPB.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{b as x}from"./chunk-4TS2OR5T.min.js";var c={aggregation:17.25,extension:17.25,composition:17.25,dependency:6,lollipop:13.5,arrow_point:4},T={arrow_point:9,arrow_cross:12.5,arrow_circle:12.5};function w(n,l){if(n===void 0||l===void 0)return{angle:0,deltaX:0,deltaY:0};n=t(n),l=t(l);let[s,e]=[n.x,n.y],[a,i]=[l.x,l.y],o=a-s,y=i-e;return{angle:Math.atan(y/o),deltaX:o,deltaY:y}}x(w,"calculateDeltaAndAngle");var t=x(n=>Array.isArray(n)?{x:n[0],y:n[1]}:n,"pointTransformer"),M=x(n=>({x:x(function(l,s,e){let a=0,i=t(e[0]).x<t(e[e.length-1]).x?"left":"right";if(s===0&&Object.hasOwn(c,n.arrowTypeStart)){let{angle:r,deltaX:g}=w(e[0],e[1]);a=c[n.arrowTypeStart]*Math.cos(r)*(g>=0?1:-1)}else if(s===e.length-1&&Object.hasOwn(c,n.arrowTypeEnd)){let{angle:r,deltaX:g}=w(e[e.length-1],e[e.length-2]);a=c[n.arrowTypeEnd]*Math.cos(r)*(g>=0?1:-1)}let o=Math.abs(t(l).x-t(e[e.length-1]).x),y=Math.abs(t(l).y-t(e[e.length-1]).y),f=Math.abs(t(l).x-t(e[0]).x),d=Math.abs(t(l).y-t(e[0]).y),h=c[n.arrowTypeStart],u=c[n.arrowTypeEnd],p=1;if(o<u&&o>0&&y<u){let r=u+p-o;r*=i==="right"?-1:1,a-=r}if(f<h&&f>0&&d<h){let r=h+p-f;r*=i==="right"?-1:1,a+=r}return t(l).x+a},"x"),y:x(function(l,s,e){let a=0,i=t(e[0]).y<t(e[e.length-1]).y?"down":"up";if(s===0&&Object.hasOwn(c,n.arrowTypeStart)){let{angle:r,deltaY:g}=w(e[0],e[1]);a=c[n.arrowTypeStart]*Math.abs(Math.sin(r))*(g>=0?1:-1)}else if(s===e.length-1&&Object.hasOwn(c,n.arrowTypeEnd)){let{angle:r,deltaY:g}=w(e[e.length-1],e[e.length-2]);a=c[n.arrowTypeEnd]*Math.abs(Math.sin(r))*(g>=0?1:-1)}let o=Math.abs(t(l).y-t(e[e.length-1]).y),y=Math.abs(t(l).x-t(e[e.length-1]).x),f=Math.abs(t(l).y-t(e[0]).y),d=Math.abs(t(l).x-t(e[0]).x),h=c[n.arrowTypeStart],u=c[n.arrowTypeEnd],p=1;if(o<u&&o>0&&y<u){let r=u+p-o;r*=i==="up"?-1:1,a-=r}if(f<h&&f>0&&d<h){let r=h+p-f;r*=i==="up"?-1:1,a+=r}return t(l).y+a},"y")}),"getLineFunctionsWithOffset");export{c as a,T as b,M as c};
|
||||
//# sourceMappingURL=chunk-LZQT2EPB.min.js.map
|
||||
File diff suppressed because one or more lines are too long
2
Docs/_site/public/chunk-MHEKKGJI.min.js
vendored
2
Docs/_site/public/chunk-MHEKKGJI.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{b as i}from"./chunk-4TS2OR5T.min.js";function t(c,e){c.accDescr&&e.setAccDescription?.(c.accDescr),c.accTitle&&e.setAccTitle?.(c.accTitle),c.title&&e.setDiagramTitle?.(c.title)}i(t,"populateCommonDb");export{t as a};
|
||||
//# sourceMappingURL=chunk-MHEKKGJI.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/chunks/mermaid.core/chunk-4BX2VUAB.mjs"],
|
||||
"sourcesContent": ["import {\n __name\n} from \"./chunk-AGHRB4JF.mjs\";\n\n// src/diagrams/common/populateCommonDb.ts\nfunction populateCommonDb(ast, db) {\n if (ast.accDescr) {\n db.setAccDescription?.(ast.accDescr);\n }\n if (ast.accTitle) {\n db.setAccTitle?.(ast.accTitle);\n }\n if (ast.title) {\n db.setDiagramTitle?.(ast.title);\n }\n}\n__name(populateCommonDb, \"populateCommonDb\");\n\nexport {\n populateCommonDb\n};\n"],
|
||||
"mappings": "4CAKA,SAASA,EAAiBC,EAAKC,EAAI,CAC7BD,EAAI,UACNC,EAAG,oBAAoBD,EAAI,QAAQ,EAEjCA,EAAI,UACNC,EAAG,cAAcD,EAAI,QAAQ,EAE3BA,EAAI,OACNC,EAAG,kBAAkBD,EAAI,KAAK,CAElC,CACAE,EAAOH,EAAkB,kBAAkB",
|
||||
"names": ["populateCommonDb", "ast", "db", "__name"]
|
||||
}
|
||||
2
Docs/_site/public/chunk-N67HA43X.min.js
vendored
2
Docs/_site/public/chunk-N67HA43X.min.js
vendored
|
|
@ -1,2 +0,0 @@
|
|||
import{W as c}from"./chunk-ETRULKCA.min.js";import{b as l}from"./chunk-4TS2OR5T.min.js";var m=l(t=>{let{handDrawnSeed:e}=c();return{fill:t,hachureAngle:120,hachureGap:4,fillWeight:2,roughness:.7,stroke:t,seed:e}},"solidStateFill"),h=l(t=>{let e=p([...t.cssCompiledStyles||[],...t.cssStyles||[],...t.labelStyle||[]]);return{stylesMap:e,stylesArray:[...e]}},"compileStyles"),p=l(t=>{let e=new Map;return t.forEach(o=>{let[a,r]=o.split(":");e.set(a.trim(),r?.trim())}),e},"styles2Map"),d=l(t=>t==="color"||t==="font-size"||t==="font-family"||t==="font-weight"||t==="font-style"||t==="text-decoration"||t==="text-align"||t==="text-transform"||t==="line-height"||t==="letter-spacing"||t==="word-spacing"||t==="text-shadow"||t==="text-overflow"||t==="white-space"||t==="word-wrap"||t==="word-break"||t==="overflow-wrap"||t==="hyphens","isLabelStyle"),S=l(t=>{let{stylesArray:e}=h(t),o=[],a=[],r=[],n=[];return e.forEach(s=>{let i=s[0];d(i)?o.push(s.join(":")+" !important"):(a.push(s.join(":")+" !important"),i.includes("stroke")&&r.push(s.join(":")+" !important"),i==="fill"&&n.push(s.join(":")+" !important"))}),{labelStyles:o.join(";"),nodeStyles:a.join(";"),stylesArray:e,borderStyles:r,backgroundStyles:n}},"styles2String"),w=l((t,e)=>{let{themeVariables:o,handDrawnSeed:a}=c(),{nodeBorder:r,mainBkg:n}=o,{stylesMap:s}=h(t);return Object.assign({roughness:.7,fill:s.get("fill")||n,fillStyle:"hachure",fillWeight:4,hachureGap:5.2,stroke:s.get("stroke")||r,seed:a,strokeWidth:s.get("stroke-width")?.replace("px","")||1.3,fillLineDash:[0,0],strokeLineDash:f(s.get("stroke-dasharray"))},e)},"userNodeOverrides"),f=l(t=>{if(!t)return[0,0];let e=t.trim().split(/\s+/).map(Number);if(e.length===1){let r=isNaN(e[0])?0:e[0];return[r,r]}let o=isNaN(e[0])?0:e[0],a=isNaN(e[1])?0:e[1];return[o,a]},"getStrokeDashArray");export{m as a,h as b,d as c,S as d,w as e};
|
||||
//# sourceMappingURL=chunk-N67HA43X.min.js.map
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/chunks/mermaid.core/chunk-ATLVNIR6.mjs"],
|
||||
"sourcesContent": ["import {\n getConfig2 as getConfig\n} from \"./chunk-ABZYJK2D.mjs\";\nimport {\n __name\n} from \"./chunk-AGHRB4JF.mjs\";\n\n// src/rendering-util/rendering-elements/shapes/handDrawnShapeStyles.ts\nvar solidStateFill = /* @__PURE__ */ __name((color) => {\n const { handDrawnSeed } = getConfig();\n return {\n fill: color,\n hachureAngle: 120,\n // angle of hachure,\n hachureGap: 4,\n fillWeight: 2,\n roughness: 0.7,\n stroke: color,\n seed: handDrawnSeed\n };\n}, \"solidStateFill\");\nvar compileStyles = /* @__PURE__ */ __name((node) => {\n const stylesMap = styles2Map([\n ...node.cssCompiledStyles || [],\n ...node.cssStyles || [],\n ...node.labelStyle || []\n ]);\n return { stylesMap, stylesArray: [...stylesMap] };\n}, \"compileStyles\");\nvar styles2Map = /* @__PURE__ */ __name((styles) => {\n const styleMap = /* @__PURE__ */ new Map();\n styles.forEach((style) => {\n const [key, value] = style.split(\":\");\n styleMap.set(key.trim(), value?.trim());\n });\n return styleMap;\n}, \"styles2Map\");\nvar isLabelStyle = /* @__PURE__ */ __name((key) => {\n return key === \"color\" || key === \"font-size\" || key === \"font-family\" || key === \"font-weight\" || key === \"font-style\" || key === \"text-decoration\" || key === \"text-align\" || key === \"text-transform\" || key === \"line-height\" || key === \"letter-spacing\" || key === \"word-spacing\" || key === \"text-shadow\" || key === \"text-overflow\" || key === \"white-space\" || key === \"word-wrap\" || key === \"word-break\" || key === \"overflow-wrap\" || key === \"hyphens\";\n}, \"isLabelStyle\");\nvar styles2String = /* @__PURE__ */ __name((node) => {\n const { stylesArray } = compileStyles(node);\n const labelStyles = [];\n const nodeStyles = [];\n const borderStyles = [];\n const backgroundStyles = [];\n stylesArray.forEach((style) => {\n const key = style[0];\n if (isLabelStyle(key)) {\n labelStyles.push(style.join(\":\") + \" !important\");\n } else {\n nodeStyles.push(style.join(\":\") + \" !important\");\n if (key.includes(\"stroke\")) {\n borderStyles.push(style.join(\":\") + \" !important\");\n }\n if (key === \"fill\") {\n backgroundStyles.push(style.join(\":\") + \" !important\");\n }\n }\n });\n return {\n labelStyles: labelStyles.join(\";\"),\n nodeStyles: nodeStyles.join(\";\"),\n stylesArray,\n borderStyles,\n backgroundStyles\n };\n}, \"styles2String\");\nvar userNodeOverrides = /* @__PURE__ */ __name((node, options) => {\n const { themeVariables, handDrawnSeed } = getConfig();\n const { nodeBorder, mainBkg } = themeVariables;\n const { stylesMap } = compileStyles(node);\n const result = Object.assign(\n {\n roughness: 0.7,\n fill: stylesMap.get(\"fill\") || mainBkg,\n fillStyle: \"hachure\",\n // solid fill\n fillWeight: 4,\n hachureGap: 5.2,\n stroke: stylesMap.get(\"stroke\") || nodeBorder,\n seed: handDrawnSeed,\n strokeWidth: stylesMap.get(\"stroke-width\")?.replace(\"px\", \"\") || 1.3,\n fillLineDash: [0, 0],\n strokeLineDash: getStrokeDashArray(stylesMap.get(\"stroke-dasharray\"))\n },\n options\n );\n return result;\n}, \"userNodeOverrides\");\nvar getStrokeDashArray = /* @__PURE__ */ __name((strokeDasharrayStyle) => {\n if (!strokeDasharrayStyle) {\n return [0, 0];\n }\n const dashArray = strokeDasharrayStyle.trim().split(/\\s+/).map(Number);\n if (dashArray.length === 1) {\n const val = isNaN(dashArray[0]) ? 0 : dashArray[0];\n return [val, val];\n }\n const first = isNaN(dashArray[0]) ? 0 : dashArray[0];\n const second = isNaN(dashArray[1]) ? 0 : dashArray[1];\n return [first, second];\n}, \"getStrokeDashArray\");\n\nexport {\n solidStateFill,\n compileStyles,\n isLabelStyle,\n styles2String,\n userNodeOverrides\n};\n"],
|
||||
"mappings": "wFAQA,IAAIA,EAAiCC,EAAQC,GAAU,CACrD,GAAM,CAAE,cAAAC,CAAc,EAAIC,EAAU,EACpC,MAAO,CACL,KAAMF,EACN,aAAc,IAEd,WAAY,EACZ,WAAY,EACZ,UAAW,GACX,OAAQA,EACR,KAAMC,CACR,CACF,EAAG,gBAAgB,EACfE,EAAgCJ,EAAQK,GAAS,CACnD,IAAMC,EAAYC,EAAW,CAC3B,GAAGF,EAAK,mBAAqB,CAAC,EAC9B,GAAGA,EAAK,WAAa,CAAC,EACtB,GAAGA,EAAK,YAAc,CAAC,CACzB,CAAC,EACD,MAAO,CAAE,UAAAC,EAAW,YAAa,CAAC,GAAGA,CAAS,CAAE,CAClD,EAAG,eAAe,EACdC,EAA6BP,EAAQQ,GAAW,CAClD,IAAMC,EAA2B,IAAI,IACrC,OAAAD,EAAO,QAASE,GAAU,CACxB,GAAM,CAACC,EAAKC,CAAK,EAAIF,EAAM,MAAM,GAAG,EACpCD,EAAS,IAAIE,EAAI,KAAK,EAAGC,GAAO,KAAK,CAAC,CACxC,CAAC,EACMH,CACT,EAAG,YAAY,EACXI,EAA+Bb,EAAQW,GAClCA,IAAQ,SAAWA,IAAQ,aAAeA,IAAQ,eAAiBA,IAAQ,eAAiBA,IAAQ,cAAgBA,IAAQ,mBAAqBA,IAAQ,cAAgBA,IAAQ,kBAAoBA,IAAQ,eAAiBA,IAAQ,kBAAoBA,IAAQ,gBAAkBA,IAAQ,eAAiBA,IAAQ,iBAAmBA,IAAQ,eAAiBA,IAAQ,aAAeA,IAAQ,cAAgBA,IAAQ,iBAAmBA,IAAQ,UACzb,cAAc,EACbG,EAAgCd,EAAQK,GAAS,CACnD,GAAM,CAAE,YAAAU,CAAY,EAAIX,EAAcC,CAAI,EACpCW,EAAc,CAAC,EACfC,EAAa,CAAC,EACdC,EAAe,CAAC,EAChBC,EAAmB,CAAC,EAC1B,OAAAJ,EAAY,QAASL,GAAU,CAC7B,IAAMC,EAAMD,EAAM,CAAC,EACfG,EAAaF,CAAG,EAClBK,EAAY,KAAKN,EAAM,KAAK,GAAG,EAAI,aAAa,GAEhDO,EAAW,KAAKP,EAAM,KAAK,GAAG,EAAI,aAAa,EAC3CC,EAAI,SAAS,QAAQ,GACvBO,EAAa,KAAKR,EAAM,KAAK,GAAG,EAAI,aAAa,EAE/CC,IAAQ,QACVQ,EAAiB,KAAKT,EAAM,KAAK,GAAG,EAAI,aAAa,EAG3D,CAAC,EACM,CACL,YAAaM,EAAY,KAAK,GAAG,EACjC,WAAYC,EAAW,KAAK,GAAG,EAC/B,YAAAF,EACA,aAAAG,EACA,iBAAAC,CACF,CACF,EAAG,eAAe,EACdC,EAAoCpB,EAAO,CAACK,EAAMgB,IAAY,CAChE,GAAM,CAAE,eAAAC,EAAgB,cAAApB,CAAc,EAAIC,EAAU,EAC9C,CAAE,WAAAoB,EAAY,QAAAC,CAAQ,EAAIF,EAC1B,CAAE,UAAAhB,CAAU,EAAIF,EAAcC,CAAI,EAiBxC,OAhBe,OAAO,OACpB,CACE,UAAW,GACX,KAAMC,EAAU,IAAI,MAAM,GAAKkB,EAC/B,UAAW,UAEX,WAAY,EACZ,WAAY,IACZ,OAAQlB,EAAU,IAAI,QAAQ,GAAKiB,EACnC,KAAMrB,EACN,YAAaI,EAAU,IAAI,cAAc,GAAG,QAAQ,KAAM,EAAE,GAAK,IACjE,aAAc,CAAC,EAAG,CAAC,EACnB,eAAgBmB,EAAmBnB,EAAU,IAAI,kBAAkB,CAAC,CACtE,EACAe,CACF,CAEF,EAAG,mBAAmB,EAClBI,EAAqCzB,EAAQ0B,GAAyB,CACxE,GAAI,CAACA,EACH,MAAO,CAAC,EAAG,CAAC,EAEd,IAAMC,EAAYD,EAAqB,KAAK,EAAE,MAAM,KAAK,EAAE,IAAI,MAAM,EACrE,GAAIC,EAAU,SAAW,EAAG,CAC1B,IAAMC,EAAM,MAAMD,EAAU,CAAC,CAAC,EAAI,EAAIA,EAAU,CAAC,EACjD,MAAO,CAACC,EAAKA,CAAG,CAClB,CACA,IAAMC,EAAQ,MAAMF,EAAU,CAAC,CAAC,EAAI,EAAIA,EAAU,CAAC,EAC7CG,EAAS,MAAMH,EAAU,CAAC,CAAC,EAAI,EAAIA,EAAU,CAAC,EACpD,MAAO,CAACE,EAAOC,CAAM,CACvB,EAAG,oBAAoB",
|
||||
"names": ["solidStateFill", "__name", "color", "handDrawnSeed", "getConfig2", "compileStyles", "node", "stylesMap", "styles2Map", "styles", "styleMap", "style", "key", "value", "isLabelStyle", "styles2String", "stylesArray", "labelStyles", "nodeStyles", "borderStyles", "backgroundStyles", "userNodeOverrides", "options", "themeVariables", "nodeBorder", "mainBkg", "getStrokeDashArray", "strokeDasharrayStyle", "dashArray", "val", "first", "second"]
|
||||
}
|
||||
340
Docs/_site/public/chunk-N6ZAD3XD.min.js
vendored
340
Docs/_site/public/chunk-N6ZAD3XD.min.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
4
Docs/_site/public/chunk-NH4WOWME.min.js
vendored
4
Docs/_site/public/chunk-NH4WOWME.min.js
vendored
|
|
@ -1,4 +0,0 @@
|
|||
import{f as a}from"./chunk-E24YF7OQ.min.js";var t={},o={info:a(async()=>{let{createInfoServices:e}=await import("./info-VBDWY6EO-45NTTHKC.min.js"),r=e().Info.parser.LangiumParser;t.info=r},"info"),packet:a(async()=>{let{createPacketServices:e}=await import("./packet-DYOGHKS2-LXE7KUMN.min.js"),r=e().Packet.parser.LangiumParser;t.packet=r},"packet"),pie:a(async()=>{let{createPieServices:e}=await import("./pie-VRWISCQL-AS5BBOPD.min.js"),r=e().Pie.parser.LangiumParser;t.pie=r},"pie"),architecture:a(async()=>{let{createArchitectureServices:e}=await import("./architecture-7HQA4BMR-HSKY6TUH.min.js"),r=e().Architecture.parser.LangiumParser;t.architecture=r},"architecture"),gitGraph:a(async()=>{let{createGitGraphServices:e}=await import("./gitGraph-G5XIXVHT-5P63GIXF.min.js"),r=e().GitGraph.parser.LangiumParser;t.gitGraph=r},"gitGraph"),radar:a(async()=>{let{createRadarServices:e}=await import("./radar-ZZBFDIW7-ZADWEJSO.min.js"),r=e().Radar.parser.LangiumParser;t.radar=r},"radar"),treemap:a(async()=>{let{createTreemapServices:e}=await import("./treemap-GDKQZRPO-N4KMX3ZB.min.js"),r=e().Treemap.parser.LangiumParser;t.treemap=r},"treemap")};async function n(e,r){let i=o[e];if(!i)throw new Error(`Unknown diagram type: ${e}`);t[e]||await i();let c=t[e].parse(r);if(c.lexerErrors.length>0||c.parserErrors.length>0)throw new m(c);return c.value}a(n,"parse");var m=class extends Error{constructor(e){let r=e.lexerErrors.map(s=>s.message).join(`
|
||||
`),i=e.parserErrors.map(s=>s.message).join(`
|
||||
`);super(`Parsing failed: ${r} ${i}`),this.result=e}static{a(this,"MermaidParseError")}};export{n as a};
|
||||
//# sourceMappingURL=chunk-NH4WOWME.min.js.map
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue