https://github.com/yjhmelody/as-container
AssemblyScript version of Rust Option<T> and Result<O, E> etc.
https://github.com/yjhmelody/as-container
assemblyscript box container option result
Last synced: 6 months ago
JSON representation
AssemblyScript version of Rust Option<T> and Result<O, E> etc.
- Host: GitHub
- URL: https://github.com/yjhmelody/as-container
- Owner: yjhmelody
- License: mit
- Created: 2021-03-25T06:22:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T22:09:29.000Z (over 1 year ago)
- Last Synced: 2025-03-18T17:23:39.850Z (7 months ago)
- Topics: assemblyscript, box, container, option, result
- Language: TypeScript
- Homepage:
- Size: 1.54 MB
- Stars: 26
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# as-container
[](https://img.shields.io/npm/v/as-container?color=light-green&label=npm%20package)
as-container provides some utils such as `Option` and `Result` inspired by Rust for other people to use.
## APIs
### Box
Box is used to wrap non-nullable(or primitive) value such as i32. Box offers all operator overloads to call the inner type operator.
Box usage scenarios are mainly used when a function or field needs to be null. This is very common in the case of generic functions and generic classes. The generics you write for reference types cannot be used for basic types, and Box is a reference type.
```ts
import { Box } from "as-container";
let box = Box.from(2);
let box2 = Box.from(1);
expect(box == box2).toStrictEqual(false);
expect(box != box2).toStrictEqual(true);
```
More examples can be found in [unit tests](./assembly/__tests__/box.spec.ts)
### Option
Option offers some operations inspired by Rust.
```ts
import { Option } from "as-container";
const x = Option.Some("some");
expect(x.map((s) => s + s).unwrap()).toBe("somesome");
```
More examples can be found in [unit tests](./assembly/__tests__/primitive/option.spec.ts)
### Result
Result offers some operations inspired by Rust.
```ts
import { Result } from "as-container";
const x = Result.Ok("233");
expect(x.map((s) => s + s).unwrap()).toBe("233233");
```
More examples can be found in [unit tests](./assembly/__tests__/primitive/result.spec.ts)
### Others
`as-container` offers two versions of Result/Option. They provide the same API, but different implementations.
The default version can handle any type including primitive type. But because the primitive types need one more byte to record state, it may take more overhead.
If you always use reference types as Option/Result parameters and need better performance, then you can use the type with the same name under `as-container/reference`.