Plinth.Common
1.7.0
Prefix Reserved
dotnet add package Plinth.Common --version 1.7.0
NuGet\Install-Package Plinth.Common -Version 1.7.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Plinth.Common" Version="1.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Plinth.Common --version 1.7.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Plinth.Common, 1.7.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Plinth.Common as a Cake Addin #addin nuget:?package=Plinth.Common&version=1.7.0 // Install Plinth.Common as a Cake Tool #tool nuget:?package=Plinth.Common&version=1.7.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
README
Plinth.Common
A set of generic utilities, extensions, and enhancements for dotnet applications
Cache
Extensions for atomic GetOrCreate on Microsoft.Extensions.Caching.Memory memory caches Example:
IMemoryCache memCache = MemoryCacheUtil.Create();
await memCache.GetOrCreateAtomicMaxDurationAsync(
"key", TimeSpan.FromMinutes(2), async () => await LoadValue());
👉 MemoryCacheUtil.Create() is a shorthand method for creating a new IMemoryCache.
Collections
- Case Insensitive Dictionary and HashSet
- Default Dictionary that will supply a default value for a key when requested
- Examples:
// values are case insensitive
var set = new CaseInsensitiveHashSet<string>() { "abc", "ABC" };
set.Contains("aBc"); // true
// LINQ extension
var set = items.Where(...).Select(...).ToCaseInsensitiveHashSet();
// keys are case insensitive
var dict = new CaseInsensitiveDictionary<string, int>() { ["abc"] = 5 };
dict["ABC"]; // 5
dict.ContainsKey("aBc"); // true
// LINQ extension
var dict = items.Where(...).Select(...).ToCaseInsensitiveDictionary(v => v.ID);
// default dictionary, easy counting
var dict = new DefaultDictionary<string, int>(0);
dict["a"]++; // dict["a"] now is 1
// default dictionary, easy multi maps
var dict = new DefaultDictionary<string, ISet<int>>(() => new HashSet<int>());
dict["a"].Add(7); // "a" has a set with (7) in it
Constants
Handy constants for Content Types
ContentTypes.ApplicationJson ⇒ "application/json; charset=utf-8"
Exceptions
Logical exceptions for common API return values. Allows for separation between logic and api projects
- LogicalBadRequestException
- LogicalConflictException
- LogicalForbiddenException
- LogicalNotFoundException
- LogicalPreconditionFailedException
Extensions
A variety of useful extensions to common classes
- For manipulating DataRow
- IDictionary
.GetValueOrDefault() - IEnumerable
.IsNullOrEmpty()and.Many() - Enum extensions for converting between enums by name (not by integer value)
- ILogger extensions for logging code durations
using (log.LogExecTiming("some code"))
{
... some code ...
log.Debug("action");
}
// logs
[CTX-6540F] : Starting some code #52400089
[CTX-6540F] : action
[CTX-6540F] : some code #52400089 Took: 00.00.00.274472
- Sensitive data extensions for masking secure items like passwords, SSNs, and credit card numbers.
- Stream extensions
.ToBytes()and.ToBytesAsync() - String extensions for converting strings to various types,
.ChangeType<T>()as various.To{Type}OrNull()
Logging
- Extensions and enhancements to Microsoft.Extensions.ILogger for better tracing when using the Plinth ecosystem
- Provides
StaticLogManager.GetLogger()to retrieve a static logger for the current class - Provides
RequestTraceIdandRequestTracePropertiessingletons for passing data through the entire call stack (including across HTTP boundaries) - Adds shorthand calls for shorter log function names.
LogTrace⇒TraceLogDebug⇒DebugLogInformation⇒InfoLogWarning⇒WarnLogError⇒ErrorLogCritical⇒CriticalorFatal
Mapping
An enhanced version of Omu.ValueInjecter for easy object to object mapping Allows for deeply nested Field to Field mapping (including Lists, Sets, and Dictionaries)
Utils
A set of static utilities
- AsyncUtil: Some async utilities, mostly obsolete as of net6.0
- DateTimeUtil: Utilities for truncating date times, UTC/TZ conversions, and some date comparison functions
- HexUtil: Conversion of hex strings to bytes and vice versa. 👉 Obsolete as of net9.0
- RuntimeUtil: Provides
FindExecutableHome()which can find your project root at runtime - TimeUtil: Provides log timing (used by ILogger extension noted above)
- UriUtil: Provides a
Join()method similar to Path.Combine()
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- Microsoft.Extensions.Caching.Memory (>= 9.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- System.Text.Json (>= 9.0.0)
- ValueInjecter (>= 3.2.0)
-
net8.0
- Microsoft.Extensions.Caching.Memory (>= 9.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- System.Text.Json (>= 9.0.0)
- ValueInjecter (>= 3.2.0)
-
net9.0
- Microsoft.Extensions.Caching.Memory (>= 9.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- System.Text.Json (>= 9.0.0)
- ValueInjecter (>= 3.2.0)
NuGet packages (18)
Showing the top 5 NuGet packages that depend on Plinth.Common:
| Package | Downloads |
|---|---|
|
Plinth.Serialization
JSON/XML/etc object serialization |
|
|
Plinth.Security
Security, Cryptography, and Token Utilities |
|
|
Plinth.HttpApiClient.Common
Shared objects for HTTP Api Client frameworks |
|
|
Plinth.HttpApiClient
HTTP Api Client framework built on MS HttpClient |
|
|
Plinth.AspNetCore
Plinth ASP.NET Core Services Utilities |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated | |
|---|---|---|---|
| 1.7.0 | 435 | 11/12/2024 | |
| 1.6.6 | 457 | 11/8/2024 | |
| 1.6.5 | 1,103 | 8/31/2024 | |
| 1.6.4 | 739 | 8/2/2024 | |
| 1.6.3 | 3,800 | 5/15/2024 | |
| 1.6.2 | 1,217 | 2/16/2024 | |
| 1.6.1 | 5,332 | 1/5/2024 | |
| 1.6.0 | 854 | 11/30/2023 | |
| 1.5.10-b186.aca976b4 | 92 | 11/30/2023 | |
| 1.5.9 | 1,989 | 11/29/2023 | |
| 1.5.9-b174.64153841 | 185 | 11/23/2023 | |
| 1.5.9-b172.dfc6e7bd | 98 | 11/17/2023 | |
| 1.5.9-b171.4e2b92e2 | 136 | 11/4/2023 | |
| 1.5.8 | 2,607 | 10/23/2023 | |
| 1.5.7 | 6,745 | 7/31/2023 | |
| 1.5.6 | 11,857 | 7/13/2023 | |
| 1.5.5 | 898 | 6/29/2023 | |
| 1.5.4 | 2,559 | 3/7/2023 | |
| 1.5.3 | 1,741 | 3/3/2023 | |
| 1.5.2 | 2,702 | 1/11/2023 | |
| 1.5.2-b92.7c961f5f | 142 | 1/11/2023 | |
| 1.5.0 | 3,018 | 11/9/2022 | |
| 1.5.0-b88.7a7c20cd | 129 | 11/9/2022 | |
| 1.4.7 | 12,749 | 10/20/2022 | |
| 1.4.6 | 6,187 | 10/17/2022 | |
| 1.4.5 | 6,571 | 10/1/2022 | |
| 1.4.4 | 11,646 | 8/16/2022 | |
| 1.4.3 | 6,953 | 8/2/2022 | |
| 1.4.2 | 6,711 | 7/19/2022 | |
| 1.4.2-b80.7fdbfd04 | 157 | 7/19/2022 | |
| 1.4.2-b74.acaf86f5 | 207 | 6/15/2022 | |
| 1.4.1 | 6,849 | 6/13/2022 | |
| 1.4.0 | 6,643 | 6/6/2022 | |
| 1.3.8 | 8,852 | 4/12/2022 | |
| 1.3.7 | 6,740 | 3/21/2022 | |
| 1.3.6 | 6,704 | 3/17/2022 | |
| 1.3.6-b67.ca5053f3 | 172 | 3/16/2022 | |
| 1.3.6-b66.4a9683e6 | 158 | 3/16/2022 | |
| 1.3.5 | 6,569 | 2/23/2022 | |
| 1.3.4 | 7,054 | 1/20/2022 | |
| 1.3.3 | 3,290 | 12/29/2021 | |
| 1.3.2 | 3,261 | 12/11/2021 | |
| 1.3.1 | 3,402 | 11/12/2021 | |
| 1.3.0 | 3,501 | 11/8/2021 | |
| 1.2.3 | 4,840 | 9/22/2021 | |
| 1.2.2 | 3,972 | 8/20/2021 | |
| 1.2.1 | 4,345 | 8/5/2021 | |
| 1.2.0 | 13,350 | 8/1/2021 | |
| 1.2.0-b37.a54030b9 | 187 | 6/24/2021 | |
| 1.1.6 | 11,780 | 3/22/2021 | |
| 1.1.5 | 3,998 | 3/9/2021 | |
| 1.1.4 | 4,964 | 2/27/2021 | |
| 1.1.3 | 3,518 | 2/17/2021 | |
| 1.1.2 | 3,538 | 2/12/2021 | |
| 1.1.1 | 3,774 | 2/1/2021 | |
| 1.1.0 | 3,497 | 12/16/2020 | |
| 1.1.0-b27.b66c309b | 312 | 11/15/2020 | |
| 1.0.12 | 5,912 | 10/18/2020 | |
| 1.0.11 | 3,649 | 10/6/2020 | |
| 1.0.10 | 3,738 | 9/30/2020 | |
| 1.0.9 | 3,559 | 9/29/2020 | |
| 1.0.8 | 3,583 | 9/26/2020 | |
| 1.0.7 | 3,567 | 9/19/2020 | |
| 1.0.6 | 3,514 | 9/3/2020 | |
| 1.0.5 | 3,658 | 9/2/2020 | |
| 1.0.4 | 3,779 | 9/1/2020 | |
| 1.0.3 | 3,422 | 9/1/2020 | |
| 1.0.2 | 3,438 | 8/29/2020 | |
| 1.0.1 | 3,438 | 8/29/2020 | |
| 1.0.0 | 3,479 | 8/29/2020 | |
| 1.0.0-b1.c22f563d | 268 | 8/28/2020 |
net9.0 support