DropBear.Codex.Core
2024.4.5
See the version list below for details.
dotnet add package DropBear.Codex.Core --version 2024.4.5
NuGet\Install-Package DropBear.Codex.Core -Version 2024.4.5
<PackageReference Include="DropBear.Codex.Core" Version="2024.4.5" />
paket add DropBear.Codex.Core --version 2024.4.5
#r "nuget: DropBear.Codex.Core, 2024.4.5"
// Install DropBear.Codex.Core as a Cake Addin #addin nuget:?package=DropBear.Codex.Core&version=2024.4.5 // Install DropBear.Codex.Core as a Cake Tool #tool nuget:?package=DropBear.Codex.Core&version=2024.4.5
Result Class Library
This library provides a set of tools for managing operation results in a robust and railway-oriented programming fashion. It offers various result types to encapsulate the outcomes of operations, handling both successes and failures gracefully without throwing exceptions. This approach enhances error handling, makes your codebase cleaner, and improves the maintainability of your applications.
Features
- Generic Result Types: Handle different data types and operations flexibly.
- Railway-Oriented Programming: Built-in methods for chaining operations based on success or failure outcomes.
- Error Handling: Advanced error handling capabilities without relying on exceptions.
- Asynchronous Support: Asynchronous methods to handle I/O-bound and CPU-intensive operations efficiently.
Installation
To install the Result Class Library, use the following NuGet command:
dotnet add package DropBear.Codex.Core
Usage Examples
Below are some examples of how to use the various result types provided by the library:
Using Result
var result = Result.Success();
if (result.IsSuccess)
{
Console.WriteLine("Operation succeeded.");
}
var failureResult = Result.Failure("Error occurred.");
failureResult.OnFailure(error => Console.WriteLine(error));
Using Result<T>
var result = Result.Success(123);
var nextResult = result.Bind(value => Result.Success(value.ToString()));
nextResult.OnSuccess(value => Console.WriteLine($"Processed value: {value}"));
Using Result<TSuccess, TFailure>
var result = Result.Success<int, string>(42);
result.Match(
success => Console.WriteLine($"Success with value: {success}"),
failure => Console.WriteLine($"Failed with error: {failure}")
);
Using Result<TSuccess, TFailure>
with Additional Handlers
var result = Result.Success<int, string>(42);
result.Match(
success => Console.WriteLine($"Success with value: {success}"),
failure => Console.WriteLine($"Failed with error: {failure}"),
onPending: () => Console.WriteLine("Operation is pending."),
onCancelled: () => Console.WriteLine("Operation was cancelled."),
onWarning: () => Console.WriteLine("Operation completed with warnings."),
onPartialSuccess: () => Console.WriteLine("Operation partially succeeded."),
onNoOp: () => Console.WriteLine("No operation was performed.")
);
Using ResultWithPayload<T>
var data = new { Name = "Example", Value = 42 };
var result = Result.SuccessWithPayload(data);
var deserialized = result.DecompressAndDeserialize();
if (deserialized.IsSuccess)
{
Console.WriteLine($"Data: {deserialized.Value.Name}");
}
Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the GNU LGPL v3. See LICENSE for more information.
Contact
Terrence Kuchel (DropBear) - Contact me via GitHub. Project Link: GitHub
Acknowledgements
- Thanks to all contributors who participate in this project.
- Special thanks to those who contribute to railway-oriented programming ideas and patterns.
Development Status
Note: This library is relatively new and under active development. While it is being developed with robustness and best practices in mind, it may still be evolving.
We encourage you to test thoroughly and contribute if possible before using this library in a production environment. The API and features may change as feedback is received and improvements are made. We appreciate your understanding and contributions to making this library better!
Please use the following link to report any issues or to contribute: GitHub Issues.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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. |
-
net8.0
- No dependencies.
NuGet packages (6)
Showing the top 5 NuGet packages that depend on DropBear.Codex.Core:
Package | Downloads |
---|---|
DropBear.Codex.Utilities
DropBear Codex Utilities. |
|
DropBear.Codex.StateManagement
The `StateSnapshotManager` library provides a comprehensive solution for managing state snapshots in .NET applications. It supports automatic snapshotting, state reversion, and notifications upon state changes, making it ideal for applications that require historical state management or undo capabilities. |
|
DropBear.Codex.Serialization
This project provides advanced serialization and deserialization capabilities, supporting formats like JSON, MessagePack, and MemoryPack. It includes performance optimizations, error handling, and supports compression and encoding options. |
|
DropBear.Codex.Files
DropBear.Codex.Files is a versatile .NET library designed for efficient file management, offering seamless integration with advanced features such as delta updates for optimized storage and bandwidth usage. Tailored for applications requiring robust file operations, it provides a foundation for both local and cloud storage scenarios, ensuring high performance and scalability. (Advanced features available when paired with DropBear.Codex.DeltaBlobStorage package.) |
|
DropBear.Codex.Operations
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2024.7.1 | 93 | 7/24/2024 |
2024.6.2 | 137 | 6/19/2024 |
2024.5.9 | 147 | 5/19/2024 |
2024.5.8 | 89 | 5/19/2024 |
2024.5.6 | 202 | 5/4/2024 |
2024.5.5 | 86 | 5/4/2024 |
2024.5.4 | 111 | 5/4/2024 |
2024.5.3 | 51 | 5/3/2024 |
2024.5.2 | 55 | 5/3/2024 |
2024.5.1 | 57 | 5/3/2024 |
2024.4.8 | 254 | 4/30/2024 |
2024.4.5 | 436 | 4/17/2024 |
2024.4.4 | 91 | 4/16/2024 |
2024.4.3 | 87 | 4/16/2024 |
2024.4.1 | 133 | 4/13/2024 |
2024.3.13 | 276 | 3/28/2024 |
2024.3.12 | 146 | 3/21/2024 |
2024.3.11 | 147 | 3/16/2024 |
2024.3.10 | 97 | 3/16/2024 |
2024.3.9 | 97 | 3/15/2024 |
2024.3.6 | 107 | 3/15/2024 |
2024.3.5 | 105 | 3/13/2024 |
2024.3.4 | 116 | 3/11/2024 |
2024.3.1 | 110 | 3/2/2024 |
2024.2.34 | 116 | 2/26/2024 |
2024.2.31 | 97 | 2/26/2024 |
2024.2.30 | 132 | 2/22/2024 |
2024.2.25 | 118 | 2/21/2024 |