Results.jl Documentation
Results.jl provides a Result and Option type for computation, as featured in Rust, Haskell (as Either), OCaml, and many more.
The core Result type is simply an alias for Union{Ok{T}, Err{E}}, allowing you to dispatch on Ok and Err variants separately. The Option type is defined as Union{Base.Some{T}, Base.Nothing}, allowing for easy compatibility with other libraries.
For a quick overview of the supported functions, visit the Quick Reference. For a detailed description of each function, visit the API. A tutorial and examples are under construction.
Outline
- Results.jl Documentation
- Quick Reference
- API
Results.Types: Core typesResults.Functions: Functions and CombinatorsResults.Macros: MacrosResults.Collection: Collection utilities
Index
Results.Types.noneResults.Types.ErrResults.Types.NoneResults.Types.OkResults.Types.OptionResults.Types.ResultResults.Types.UnwrapErrorBase.:!Base.:&Base.:==Base.:==Base.:==Base.:|Base.eltypeBase.eltypeBase.eltypeBase.eltypeBase.iterateBase.iterateBase.iterateBase.iterateBase.lengthBase.lengthBase.lengthBase.lengthBase.showBase.showResults.Collection.try_firstResults.Collection.try_firstResults.Collection.try_getResults.Collection.try_getResults.Collection.try_getResults.Collection.try_getResults.Collection.try_getResults.Collection.try_getResults.Collection.try_lastResults.Collection.try_peekResults.Collection.try_pop!Results.Collection.try_pop!Results.Collection.try_pop!Results.Collection.try_pop!Results.Collection.try_pop!Results.Functions.:←Results.Functions.:→Results.Functions.:⊗Results.Functions.and_thenResults.Functions.and_thenResults.Functions.and_thenResults.Functions.flattenResults.Functions.has_valResults.Functions.is_errResults.Functions.is_errResults.Functions.is_noneResults.Functions.is_okResults.Functions.is_okResults.Functions.is_someResults.Functions.is_someResults.Functions.map_errResults.Functions.map_errResults.Functions.okResults.Functions.ok_orResults.Functions.ok_orResults.Functions.strip_option_typeResults.Functions.strip_result_typeResults.Functions.to_nullableResults.Functions.to_optionResults.Functions.to_resultResults.Functions.to_resultResults.Functions.try_collectResults.Functions.try_collect_optionResults.Functions.try_collect_resultResults.Functions.try_mapResults.Functions.try_mapResults.Functions.unwrapResults.Functions.unwrap_orResults.Macros.@catch_resultResults.Macros.@if_letResults.Macros.@some_ifResults.Macros.@try_unwrapResults.Macros.@unwrap_orResults.Macros.@while_let