option_result 3.2.0
option_result: ^3.2.0 copied to clipboard
A lightweight Dart library for Rust-like Option/Result types. Supports exhaustive pattern matching and provides helpers for None()/Err() propagation
3.2.0 #
- Add
FutureOption<T>
typedef. - Add
FutureOrOption<T>
typedef. - Add
FutureResult<T, E>
typedef. - Add
FutureOrResult<T, E>
typedef.
3.1.3 #
- Fix code snippet in readme.
3.1.2 #
- Clean up
flatten()
implementations. - Add source links to docs.
3.1.1 #
- Update README.
3.1.0 #
- Add
value
field shorthand getters forOption
types. - Add
value
field shorthand getters forResult
types.
3.0.1 #
- Fix README formatting.
3.0.0 #
- Add
call()
extension for the following types to allow calling them like a function for easy unwrapping of theirOption
/Result
values:Future<Option<T>>
FutureOr<Option<T>>
Future<Result<T, E>>
FutureOr<Result<T, E>>
Breaking changes #
- Remove deprecated
~
operator forOption
andResult
type values. - Remove
~
operator forResult<(), E>
type values.-
The only reason this was added was to keep
~await failableOperation()
ergonomic, but this can be accomplished with acall()
extension onFuture
/FutureOr
values which keeps the quick method of unwrappingOption
/Result
values consistent accross the library.~a + ~b
becamea() + b()
~optionFn()
becameoptionFn()()
~resultFn()
becameresultFn()()
and now:~await optionFnAsync()
becomesawait optionFnAsync()()
~await resultFnAsync()
becomesawait resultFnAsync()()
-
2.2.0 #
- Un-deprecate
~
operator forResult<(), E>
type values- This keeps the ergonomics of
~
for unwrapping awaited Results, but only where the value would be discarded anyway, i.e., unwrapping a result that is only used for error handling inside acatchResult
orcatchResultAsync
block so that the error can propagate.
- This keeps the ergonomics of
2.1.0 #
- Add
Option.call()
to allow callingOption
values like a function to unwrap their held values. - Add
Result.call()
to allow callingResult
values like a function to unwrap their held values.
Deprecation #
- Deprecated
~
operators forOption
andResult
types.- Use
Option/Result.call()
asvalue()
to unwrap with minimal syntax instead.- This prevents the need for accommodating operator precedence when unwrapping
Option
/Result
values which provides a more ergonomic experience when accessing values/methods on the unwrapped value is needed.
- This prevents the need for accommodating operator precedence when unwrapping
- Use
2.0.1 #
- Remove work-in-progress message from readme.
- How did I miss this?
- help
- How did I miss this?
2.0.0 #
Breaking changes #
- Remove
~
shortcut for prefixing Option/Result propagation functions.-
I failed to test the most obvious use-case. Due to the lack of generics on operators, when both variants of
Option
orResult
are returned in the same prefixed function, the return type is inferred by the compiler to beObject
and the propagation extensions then fail to recognize the function as a valid target for the~
operator.To compensate, I made the Option/Result propagation helpers easier to type by renaming them, saving 4 characters and 2 syllables. It's the best I can think of until such time that Dart supposed fully generic operator definitions.
-
- Rename
propagateOption()
->catchOption()
. - Rename
propagateResult()
->catchResult()
. - Rename
propagateOptionAsync()
->catchOptionAsync()
. - Rename
propagateResultAsync()
->catchResultAsync()
.
1.0.0 #
- Final documentation update for 1.0.0 release. 🎉
0.1.0-dev-4 #
- Update documentation.
0.1.0-dev-3 #
- Allow
const
Option
andResult
values. - Rename
Option#filter()
->Option#where()
.- This is more Dart-idiomatic.
0.1.0-dev-2 #
- Add
Option#iter()
. - Add
Result#iter()
.
0.1.0-dev-1 #
- Add
Option#toString()
. - Add
Result#toString()
. - Rework
==
forOption
andResult
types.- Previously
==
would check for matching runtime types in addition to held value equality. I was trying to keep things as close to Rust's behavior as I could. It didn't occur to me until after I rewrote it to be more accommodating ofdynamic
values that it didn't support comparing held values that inherit from eachother that might normally be comparable in both the original implementation and the rewrite so I scrapped both in favor of solely comparing held values.
- Previously
0.0.1-dev-9 #
- Add
Result#transpose()
,ok()
,err()
.
0.0.1-dev-8 #
- Add
Option#unwrapOrElse()
,okOr()
,okOrElse()
,transpose()
. - Add
Result#unwrapOrElse()
,isOkAnd()
,isErrAnd()
,mapOr()
,mapOrElse()
.
0.0.1-dev-7 #
- Add
Option#inspect()
,xor()
,isSomeAnd()
,mapOr()
,mapOrElse()
. - Add
Result#inspect()
,inspectErr()
.
0.0.1-dev-6 #
- Add
Option#flatten()
. - Add
Result#flatten()
. - Refactor
~
shortcut forpropagateResult/Async
to return dynamic for ergonomics.- See documentation for more information.
0.0.1-dev-5 #
- Add
~
operator for unwrappingOption
andResult
types. - Add
~
operator as shortcut for propagatingNone()
/Err()
in functions returningOption
/Result
. - Rework
Option#unzip()
via extension methods to only provide the method onOption<(T, U)>
values.
0.0.1-dev-4 #
- Add
Option#and()
,andThen()
,or()
,orElse()
,expect()
. - Add
Result#and()
,andThen()
,or()
,orElse()
,expect()
,expectErr()
.
0.0.1-dev-3 #
- Add
Option#map()
,zip()
,zipWith()
,unzip()
. - Add
Result#map()
,mapErr()
. - Reworked
propagateResult/Async
semantics to be more in-line with Rust'sResult
Err
propagation.
0.0.1-dev-2 #
- Add separate packages to allow importing
option
andresult
separately. - Add
Option#filter()
method.
0.0.1-dev-1 #
- Initial version.