Skip to content

Latest commit

 

History

History
146 lines (129 loc) · 4.87 KB

README.md

File metadata and controls

146 lines (129 loc) · 4.87 KB
Raw

Sirh3e.Rust

GitHub Nuget Nuget

Sirh3e.Rust is a library that provide missing features in C# where are fundamental in the Rust Programming Language like Option and Result.

See features for all available methods.

Status

Type Service Status
.NET Core Build Github Action dotnet build
.NET Core Test Github Action dotnet test
.NET Format Github Action dotnet format
Maintainability CODE CLIMATE Maintainability
Test Coverage CODE CLIMATE Test Coverage
Code Quality CodeFactor CodeFactor

License

BSD-3-Clause

Nuget

dotnet add package Sirh3e.Rust --version 1.0.0-preview-0006

Features

Legend:

  • ✅ Implemented no bugs/🐛 known.
  • ❌ Not implemented and will not be to implement do to C# language boundaries.
  • 🍬 Feature which is not in rust but fit's nicely in C# language most likely used for Async
  • 🦉 Is for nightly features
  • 🚧 Currently under construction will raise NotImplementedException.
  • 😐 Rust concept that is not required in C#.
  1. Option
    • Methods:
    • ✅ And
    • ✅ AndThen
    • 😐 AsDeref
    • 😐 AsDerefMut
    • 😐 AsPinMut
    • 😐 AsPinRef
    • 😐 AsRef
    • ✅ Cloned
    • ✅ Contains
    • 😐 Copied
    • ✅ Expect
    • ✅ ExpectFailed
    • ✅ ExpectNone
    • ✅ ExpectNoneFailed
    • ✅ Filter
    • ✅ Flatten
    • ✅ GetOrInsert
    • 🦉 GetOrInsertDefault
    • ✅ GetOrInsertWith
    • ✅ Insert
    • 🦉 Inspect
    • ✅ IsNone
    • ✅ IsSome
    • 🦉 IsSomeAnd
    • ✅ Iter
    • ❌ IterMut
    • ✅ Map
    • 🍬 MapAsync
    • ✅ MapOr
    • 🍬 MapOrAsync
    • ✅ MapOrElse
    • 🍬 MapOrElseAsync
    • ✅ OkOr
    • ✅ OkOrElse
    • ✅ Or
    • ✅ OrElse
    • ✅ Replace
    • ✅ Take
    • ✅ Transpose
    • ✅ Unwrap
    • ✅ UnwrapNone
    • ✅ UnwrapOr
    • ✅ UnwrapOrDefault
    • ✅ UnwrapOrElse
    • 🦉 UnwrapUnchecked
    • 🦉 Unzip
    • ✅ Xor
    • ✅ Zip
    • ✅ ZipWith
  2. Result
    • Methods:
    • ✅ And
    • ✅ AndThen
    • 😐 AsDeref
    • 😐 AsDerefMut
    • 😐 AsMut
    • 😐 AsRef
    • ✅ Cloned
    • ✅ Contains
    • ✅ ContainsErr
    • 😐 Copied
    • ✅ Err
    • ✅ Expect
    • ✅ ExpectErr
    • ✅ Flatten
    • 🦉 Inspect
    • 🦉 InspectErr
    • ✅ IntoOk
    • 🦉 IntoOkOrErr
    • ✅ IsErr
    • 🦉 IsErrAnd
    • ✅ IsOk
    • 🦉 IsOkAnd
    • ✅ Iter
    • ❌ IterMut
    • ✅ Map
    • 🍬 MapAsync
    • ✅ MapErr
    • 🍬 MapErrAsync
    • ✅ MapOr
    • 🍬 MapOrAsync
    • ✅ MapOrElse
    • 🍬 MapOrElseAsync
    • ✅ Ok
    • ✅ Or
    • ✅ OrElse
    • ✅ Transpose
    • ✅ Unwrap
    • ✅ UnwrapErr
    • ✅ UnwrapErrUnchecked
    • ✅ UnwrapOr
    • ✅ UnwrapOrDefault
    • ✅ UnwrapOrElse
    • ✅ UnwrapUnchecked

Becoming Active in Sirh3e.Rust development

New contributors are always welcome and I am happy to provide guidance if necessary.

Semantic Versioning

Sirh3e.Rust project strictly adhere to a semantic versioning scheme.