409 lines
17 KiB
HTML
409 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Namespace Hi.Common | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Namespace Hi.Common | HiAPI-C# 2025 ">
|
|
|
|
|
|
<link rel="icon" href="../img/HiAPI.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="ManagedReference">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="Hi.Common">
|
|
|
|
<h1 id="Hi_Common" data-uid="Hi.Common" class="text-break">Namespace Hi.Common</h1>
|
|
<div class="markdown level0 summary"></div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="markdown level0 remarks"></div>
|
|
|
|
<h3 id="classes">
|
|
Classes
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.BinIoUtil.html">BinIoUtil</a></dt>
|
|
<dd><p>Utility class for binary I/O operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.BitUtil.html">BitUtil</a></dt>
|
|
<dd><p>Utility for bit control for integer.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.BlockingTimer.html">BlockingTimer</a></dt>
|
|
<dd><p>Timer use one task and delay each event call.
|
|
The delay time is <a class="xref" href="Hi.Common.BlockingTimer.html#Hi_Common_BlockingTimer_Period">Period</a>, counted from the previous trigger to the nest trigger.
|
|
The first function call does no intending delay.
|
|
If the execution time is over the <a class="xref" href="Hi.Common.BlockingTimer.html#Hi_Common_BlockingTimer_Period">Period</a>, no delay between the triggers.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.BytesUtil.html">BytesUtil</a></dt>
|
|
<dd><p>Utility class for byte array operations and memory size conversions.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ConcurrentTimeCounter.html">ConcurrentTimeCounter</a></dt>
|
|
<dd><p>Thread-safe utility for measuring and tracking execution time across multiple tasks.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ConsoleUtil.html">ConsoleUtil</a></dt>
|
|
<dd><p>Utility class for console window operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.CppLogUtil.html">CppLogUtil</a></dt>
|
|
<dd><p>Internal Use Only.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.CultureUtil.html">CultureUtil</a></dt>
|
|
<dd><p>Utility class for managing culture and localization settings.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.DebugUtil.html">DebugUtil</a></dt>
|
|
<dd><p>Debug utility provides functions: pause process, count execution time and show the count.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.DuplicateUtil.html">DuplicateUtil</a></dt>
|
|
<dd><p>Utility methods for duplication operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.EnumUtil.html">EnumUtil</a></dt>
|
|
<dd><p>Utility class for enum operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.EnumerablePlayer.html">EnumerablePlayer</a></dt>
|
|
<dd><p>Run enumerable with <a class="xref" href="Hi.Common.EnumerablePlayer.html#Hi_Common_EnumerablePlayer_Pause">Pause()</a>, <a class="xref" href="Hi.Common.EnumerablePlayer.html#Hi_Common_EnumerablePlayer_Resume">Resume()</a> and etc. functions.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a></dt>
|
|
<dd><p>Provides utility methods for handling exceptions.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IndexSegment.html">IndexSegment</a></dt>
|
|
<dd><p>Represents a segment of indices with a beginning (inclusive) and ending (exclusive> point.
|
|
Used for defining segment of data in collections or arrays.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IntegerKeyDictionaryConverter.html">IntegerKeyDictionaryConverter</a></dt>
|
|
<dd><p>Converts dictionaries with string keys to dictionaries with integer keys for more efficient storage and lookup.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IntegerKeyDictionaryConverter-1.html">IntegerKeyDictionaryConverter<TValue></a></dt>
|
|
<dd><p>Generic version of <a class="xref" href="Hi.Common.IntegerKeyDictionaryConverter.html">IntegerKeyDictionaryConverter</a> that works with a specific value type.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.InternalException.html">InternalException</a></dt>
|
|
<dd><p>Exception that represents an internal error that should never occur during normal operation.
|
|
Used to indicate programming errors or unexpected states that require developer attention.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.InvokeUtil.html">InvokeUtil</a></dt>
|
|
<dd><p>Utility class for method invocation operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.JsonUtil.html">JsonUtil</a></dt>
|
|
<dd><p>Helper utilities for reading and writing JSON files.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.LooseRunner.html">LooseRunner</a></dt>
|
|
<dd><p>Provides a mechanism for running actions asynchronously in a loose manner.
|
|
Only the most recent action is executed and previous pending actions are discarded.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ManualUtil.html">ManualUtil</a></dt>
|
|
<dd><p>Utility class for handling manual and documentation files with culture support.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.MaskUtil.html">MaskUtil</a></dt>
|
|
<dd><p>Utility for bits masking.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.NameUtil.html">NameUtil</a></dt>
|
|
<dd><p>Utility class for handling object names and display names.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.PacePlayee.html">PacePlayee</a></dt>
|
|
<dd><p>Represents an entity that can be controlled by the pace player.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.PacePlayer.html">PacePlayer</a></dt>
|
|
<dd><p>Controls the pace execution of a task.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.Pair-2.html">Pair<TA, TB></a></dt>
|
|
<dd><p>Editable pair values.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.Range-1.html">Range<T></a></dt>
|
|
<dd><p>Range from <a class="xref" href="Hi.Common.Range-1.html#Hi_Common_Range_1_Min">Min</a> to <a class="xref" href="Hi.Common.Range-1.html#Hi_Common_Range_1_Max">Max</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ResourceUtil.html">ResourceUtil</a></dt>
|
|
<dd><p>Utility class for working with resource managers and localized strings.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.RoutineBlocker.html">RoutineBlocker</a></dt>
|
|
<dd><p>Block the thread to the given delay from the previous block.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.RoutineBlocker0.html">RoutineBlocker0</a></dt>
|
|
<dd><p>Block the thread to the given delay from the previous block.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.SeqPairUtil.html">SeqPairUtil</a></dt>
|
|
<dd><p>Utility class for SeqPair operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.SeqPair-1.html">SeqPair<T></a></dt>
|
|
<dd><p>Represents a sequence pair containing previous and current values.
|
|
Used to track sequential state changes of a value.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ServerFileExplorerConfig.html">ServerFileExplorerConfig</a></dt>
|
|
<dd><p>Configuration for server file explorer functionality.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.Slice.html">Slice</a></dt>
|
|
<dd><p>Designed for mongo large bytes splision.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.StringLocalizer.html">StringLocalizer</a></dt>
|
|
<dd><p>Provides localization functionality for strings using resource managers.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.StringUtil.html">StringUtil</a></dt>
|
|
<dd><p>Utility for managing text.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.TaskUtil.html">TaskUtil</a></dt>
|
|
<dd><p>Utility class for Task-related operations.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.TimeCounter.html">TimeCounter</a></dt>
|
|
<dd><p>A utility counts the average/total time consume between the <a class="xref" href="Hi.Common.TimeCounter.html#Hi_Common_TimeCounter_Bound_System_Object_">Bound(object)</a> areas.
|
|
The count of time consume for the given key starts at the first time (and the odd time) calling <a class="xref" href="Hi.Common.TimeCounter.html#Hi_Common_TimeCounter_Bound_System_Object_">Bound(object)</a>;
|
|
stops and accumulates at the second time (and the even time).</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="interfaces">
|
|
Interfaces
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IAbstractNote.html">IAbstractNote</a></dt>
|
|
<dd><p>Interface for objects that provide an abstract description or note.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IBinaryIo.html">IBinaryIo</a></dt>
|
|
<dd><p>Interface for binary input/output operations.
|
|
Extends <a class="xref" href="Hi.Common.IWriteBin.html">IWriteBin</a> to provide both read and write capabilities.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IClearCache.html">IClearCache</a></dt>
|
|
<dd><p>Interface for objects that can clear their internal cache.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></dt>
|
|
<dd><p>Interface for objects that support deep cloning/duplication.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IGetQuantityByKey.html">IGetQuantityByKey</a></dt>
|
|
<dd><p>Interface for retrieving a quantity value using a string key.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IGetSelectionName.html">IGetSelectionName</a></dt>
|
|
<dd><p>Interface for objects that can provide a name for selection purposes.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.INameNote.html">INameNote</a></dt>
|
|
<dd><p>Interface for objects that have a name and note property.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IPreferredFileName.html">IPreferredFileName</a></dt>
|
|
<dd><p>Interface for objects that can specify a preferred file name.
|
|
Generally used to suggest a name when generating or saving files.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.ISourceFile.html">ISourceFile</a></dt>
|
|
<dd><p>Interface for objects that have a source file.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IUpdateByContent.html">IUpdateByContent</a></dt>
|
|
<dd><p>Interface for objects that can update themselves based on their content.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IUriGetter.html">IUriGetter</a></dt>
|
|
<dd><p>Interface for retrieving a URI string.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.IWriteBin.html">IWriteBin</a></dt>
|
|
<dd><p>Interface for writing binary data.</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="enums">
|
|
Enums
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
|
|
<dd><p>Represents the result of a binary search operation.</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="delegates">
|
|
Delegates
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.CppLogUtil.LogDelegate.html">CppLogUtil.LogDelegate</a></dt>
|
|
<dd><p>Internal Use Only.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="Hi.Common.LooseRunner.MergedCancellationTokenRun.html">LooseRunner.MergedCancellationTokenRun</a></dt>
|
|
<dd><p>Delegate for actions that accept a merged cancellation token.
|
|
The merged token combines the runner's disposal token with an optional external cancellation token.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|