Skip to content

Commit

Permalink
docs: Update
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmah309 committed Dec 11, 2023
1 parent 4139336 commit 9722e12
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,24 @@
[![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://github.com/mcmah309/rust_core/actions/workflows/dart.yml/badge.svg)](https://github.com/mcmah309/rust_core/actions)

Implementation of Rust's core library in a Dart friendly way.
Implementing Rust's Core Library in Dart.

rust_core allows for idiomatic programming in dart with predictable control flow. We carefully adapt Rust's
functionalities to Dart's paradigms, ensuring a smooth,
language-compatible integration. E.g. `Option` and Nullable types are equally supported throughout. If a method or
extension exists for `Option<T>` it exists for `T?`. Thus, rust_core seamlessly integrates the essence of Rust's
core library into Dart.
`rust_core` provides a Dart-friendly implementation of Rust's core library, enabling idiomatic programming with
predictable control flow. Rust's functionalities are carefully adapted to Dart's paradigms, focusing on smooth
and language-compatible integration.

## Highlights
### Libraries

| [Result] | [Option] | [Cell] | [Panic] | [Typedefs]

🔥 **Dozens of Extensions, 100's of methods:** Crafted to address specific scenarios in Dart.
🔥 **Extensive Extensions:** Dozens of additional extensions with hundreds of methods tailored for Dart. These
extensions are designed for maximum composability, addressing specific scenarios.

🧪 **Robust Testing:** Over 300 meaningful tests, we aim for reliability and performance in every feature.
🚀 **Dart Friendly:** Dual Support for `Option` and Nullable Types. If a method or extension exists for `Option<T>`,
it's also available for `T?`, offering flexibility and consistency in your coding.

🚀 **Beyond Rust Core:** While rust_core faithfully implements the Rust Core library in Dart, our vision extends further.
We aim to be an indispensable tool for every Dart project and a foundational library for the broader ecosystem.
🧪 **Robust Testing:** Every feature tested. Over 300 meaningful tests. Reliability and performance in every feature.

### Official Packages Based Off rust_core
| Library | Description |
Expand Down
2 changes: 1 addition & 1 deletion lib/src/cell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ expect(secondCall, equals(20));
Most of the time you will not need to know or care about this, and working
with the regular cell types is usually preferred, but
all Cells have `const`, `nullable` and `non-nullable` implementations. These were added for efficiency and to give
more control to developers. e.g. Non-Nullable `OnceCell` and `LazyCell` (which is the default) don't need an
more control to developers. e.g. Non-Nullable `OnceCell` and `LazyCell` (which is the default) doesn't need an
additional `bool` to keep track if the value is set.

The base type for all `Cell`s is `ConstCell`.
Expand Down
3 changes: 2 additions & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: rust_core
description: Implementation of Rust's core library in a Dart friendly way. Includes Result, Option, Cells, etc.
description: Idiomatic Dart programming with predictable control flow, inspired by Rust's core library.
Includes types like Result, Option, Cells, and extensive methods/extensions.
version: 0.3.4
repository: https://github.com/mcmah309/rust_core

Expand Down

0 comments on commit 9722e12

Please sign in to comment.