admin/pardeike-Harmony
1
0
Fork 0
mirror of https://github.com/pardeike/Harmony synced 2026-06-08 16:40:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
pardeike-Harmony/docs/api/HarmonyLib.GeneralExtensions.html
T
Andreas Pardeike 0072943ba5 draft for docs
2025-08-23 00:31:53 +02:00

616 lines
21 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class GeneralExtensions
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class GeneralExtensions
">
<meta name="generator" content="docfx 2.48.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="HarmonyLib.GeneralExtensions">
<h1 id="HarmonyLib_GeneralExtensions" data-uid="HarmonyLib.GeneralExtensions" class="text-break">Class GeneralExtensions
</h1>
<div class="markdown level0 summary"><p>General extensions for common cases</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">GeneralExtensions</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="HarmonyLib.html">HarmonyLib</a></h6>
<h6><strong>Assembly</strong>: 0Harmony.dll</h6>
<h5 id="HarmonyLib_GeneralExtensions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class GeneralExtensions</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="HarmonyLib_GeneralExtensions_Description_" data-uid="HarmonyLib.GeneralExtensions.Description*"></a>
<h4 id="HarmonyLib_GeneralExtensions_Description_System_Type___" data-uid="HarmonyLib.GeneralExtensions.Description(System.Type[])">Description(Type[])</h4>
<div class="markdown level1 summary"><p>Converts an array of types (for example methods arguments) into a human readable form</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string Description(this Type[] parameters)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span>[]</td>
<td><span class="parametername">parameters</span></td>
<td><p>The array of types</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A human readable description including brackets</p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_FullDescription_" data-uid="HarmonyLib.GeneralExtensions.FullDescription*"></a>
<h4 id="HarmonyLib_GeneralExtensions_FullDescription_System_Reflection_MethodBase_" data-uid="HarmonyLib.GeneralExtensions.FullDescription(System.Reflection.MethodBase)">FullDescription(MethodBase)</h4>
<div class="markdown level1 summary"><p>A a full description of a method or a constructor without assembly details but with generics</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string FullDescription(this MethodBase member)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Reflection.MethodBase</span></td>
<td><span class="parametername">member</span></td>
<td><p>The method/constructor</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A human readable description</p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_FullDescription_" data-uid="HarmonyLib.GeneralExtensions.FullDescription*"></a>
<h4 id="HarmonyLib_GeneralExtensions_FullDescription_System_Type_" data-uid="HarmonyLib.GeneralExtensions.FullDescription(System.Type)">FullDescription(Type)</h4>
<div class="markdown level1 summary"><p>A full description of a type</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string FullDescription(this Type type)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">type</span></td>
<td><p>The type</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A human readable description</p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_GetTypedValue_" data-uid="HarmonyLib.GeneralExtensions.GetTypedValue*"></a>
<h4 id="HarmonyLib_GeneralExtensions_GetTypedValue__1_System_Collections_Generic_Dictionary_System_String_System_Object__System_String_" data-uid="HarmonyLib.GeneralExtensions.GetTypedValue``1(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">GetTypedValue&lt;T&gt;(Dictionary&lt;String, Object&gt;, String)</h4>
<div class="markdown level1 summary"><p>A helper to access a value via key from a dictionary with extra casting</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T GetTypedValue&lt;T&gt;(this Dictionary&lt;string, object&gt; dictionary, string key)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Dictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">System.Object</span>&gt;</td>
<td><span class="parametername">dictionary</span></td>
<td><p>The dictionary</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">key</span></td>
<td><p>The key</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><p>The value for the key or the default value (of T) if that key does not exist or cannot be cast to T</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The value type</p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_GetValueSafe_" data-uid="HarmonyLib.GeneralExtensions.GetValueSafe*"></a>
<h4 id="HarmonyLib_GeneralExtensions_GetValueSafe__2_System_Collections_Generic_Dictionary___0___1____0_" data-uid="HarmonyLib.GeneralExtensions.GetValueSafe``2(System.Collections.Generic.Dictionary{``0,``1},``0)">GetValueSafe&lt;S, T&gt;(Dictionary&lt;S, T&gt;, S)</h4>
<div class="markdown level1 summary"><p>A helper to access a value via key from a dictionary</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T GetValueSafe&lt;S, T&gt;(this Dictionary&lt;S, T&gt; dictionary, S key)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Dictionary</span>&lt;S, T&gt;</td>
<td><span class="parametername">dictionary</span></td>
<td><p>The dictionary</p>
</td>
</tr>
<tr>
<td><span class="xref">S</span></td>
<td><span class="parametername">key</span></td>
<td><p>The key</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><p>The value for the key or the default value (of T) if that key does not exist</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">S</span></td>
<td><p>The key type</p>
</td>
</tr>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The value type</p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_HasHarmonyAttribute_" data-uid="HarmonyLib.GeneralExtensions.HasHarmonyAttribute*"></a>
<h4 id="HarmonyLib_GeneralExtensions_HasHarmonyAttribute_System_Type_" data-uid="HarmonyLib.GeneralExtensions.HasHarmonyAttribute(System.Type)">HasHarmonyAttribute(Type)</h4>
<div class="markdown level1 summary"><p>Tests if a type has the <a class="xref" href="HarmonyLib.HarmonyAttribute.html">HarmonyAttribute</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool HasHarmonyAttribute(this Type type)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">type</span></td>
<td><p>The class/type to test</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if the type has the <a class="xref" href="HarmonyLib.HarmonyAttribute.html">HarmonyAttribute</a></p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_Join_" data-uid="HarmonyLib.GeneralExtensions.Join*"></a>
<h4 id="HarmonyLib_GeneralExtensions_Join__1_System_Collections_Generic_IEnumerable___0__System_Func___0_System_String__System_String_" data-uid="HarmonyLib.GeneralExtensions.Join``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.String},System.String)">Join&lt;T&gt;(IEnumerable&lt;T&gt;, Func&lt;T, String&gt;, String)</h4>
<div class="markdown level1 summary"><p>Joins an enumeration with a value converter and a delimiter to a string</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string Join&lt;T&gt;(this IEnumerable&lt;T&gt; enumeration, Func&lt;T, string&gt; converter = null, string delimiter = &quot;, &quot;)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
<td><span class="parametername">enumeration</span></td>
<td><p>The enumeration</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;T, <span class="xref">System.String</span>&gt;</td>
<td><span class="parametername">converter</span></td>
<td><p>An optional value converter (from T to string)</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">delimiter</span></td>
<td><p>An optional delimiter</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>The values joined into a string</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The inner type of the enumeration</p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_ToLiteral_" data-uid="HarmonyLib.GeneralExtensions.ToLiteral*"></a>
<h4 id="HarmonyLib_GeneralExtensions_ToLiteral_System_String_System_String_" data-uid="HarmonyLib.GeneralExtensions.ToLiteral(System.String,System.String)">ToLiteral(String, String)</h4>
<div class="markdown level1 summary"><p>Escapes Unicode and ASCII non printable characters</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string ToLiteral(this string input, string quoteChar = &quot;\&quot;&quot;)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">input</span></td>
<td><p>The string to convert</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">quoteChar</span></td>
<td><p>The string to convert</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A string literal surrounded by <code data-dev-comment-type="paramref" class="paramref">quoteChar</code></p>
</td>
</tr>
</tbody>
</table>
<a id="HarmonyLib_GeneralExtensions_Types_" data-uid="HarmonyLib.GeneralExtensions.Types*"></a>
<h4 id="HarmonyLib_GeneralExtensions_Types_System_Reflection_ParameterInfo___" data-uid="HarmonyLib.GeneralExtensions.Types(System.Reflection.ParameterInfo[])">Types(ParameterInfo[])</h4>
<div class="markdown level1 summary"><p>A helper converting parameter infos to types</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Type[] Types(this ParameterInfo[] pinfo)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Reflection.ParameterInfo</span>[]</td>
<td><span class="parametername">pinfo</span></td>
<td><p>The array of parameter infos</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span>[]</td>
<td><p>An array of types</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink