Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Task/AsyncOption defaultValue and defaultWith #238

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/FsToolkit.ErrorHandling.TaskResult/TaskOption.fs
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,30 @@ module TaskOption =
| Some v -> onSome v
| None -> onNone ()
)

/// <summary>
/// Gets the value of the option if the option is <c>Some</c>, otherwise returns the specified default value.
/// </summary>
/// <param name="value">The specified default value.</param>
/// <param name="asyncOption">The input option.</param>
/// <returns>
/// The option if the option is <c>Some</c>, else the default value.
/// </returns>
let inline defaultValue (value: 'value) (taskOption: Task<'value option>) =
taskOption
|> Task.map (Option.defaultValue value)

/// <summary>
/// Gets the value of the option if the option is <c>Some</c>, otherwise evaluates <paramref name="defThunk"/> and returns the result.
/// </summary>
/// <param name="defThunk">A thunk that provides a default value when evaluated.</param>
/// <param name="asyncOption">The input option.</param>
/// <returns>
/// The option if the option is <c>Some</c>, else the result of evaluating <paramref name="defThunk"/>.
/// </returns>
let inline defaultWith
([<InlineIfLambda>] defThunk: unit -> 'value)
(taskOption: Task<'value option>)
: Task<'value> =
taskOption
|> Task.map (Option.defaultWith defThunk)
27 changes: 27 additions & 0 deletions src/FsToolkit.ErrorHandling/AsyncOption.fs
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,30 @@ module AsyncOption =
| Some v -> onSome v
| None -> onNone
)

/// <summary>
/// Gets the value of the option if the option is <c>Some</c>, otherwise returns the specified default value.
/// </summary>
/// <param name="value">The specified default value.</param>
/// <param name="asyncOption">The input option.</param>
/// <returns>
/// The option if the option is <c>Some</c>, else the default value.
/// </returns>
let inline defaultValue (value: 'value) (asyncOption: Async<'value option>) =
asyncOption
|> Async.map (Option.defaultValue value)

/// <summary>
/// Gets the value of the option if the option is <c>Some</c>, otherwise evaluates <paramref name="defThunk"/> and returns the result.
/// </summary>
/// <param name="defThunk">A thunk that provides a default value when evaluated.</param>
/// <param name="asyncOption">The input option.</param>
/// <returns>
/// The option if the option is <c>Some</c>, else the result of evaluating <paramref name="defThunk"/>.
/// </returns>
let inline defaultWith
([<InlineIfLambda>] defThunk: unit -> 'value)
(asyncOption: Async<'value option>)
: Async<'value> =
asyncOption
|> Async.map (Option.defaultWith defThunk)
48 changes: 48 additions & 0 deletions tests/FsToolkit.ErrorHandling.TaskResult.Tests/TaskOption.fs
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,52 @@ let eitherTests =
}
]

let defaultValueTests =
testList "TaskOption.defaultValue Tests" [
testCaseTask "Some"
<| fun () ->
task {
let defaultValue = 10
let expectedValue = 5

let taskOption = TaskOption.retn expectedValue
let! result = TaskOption.defaultValue defaultValue taskOption
Expect.equal result expectedValue ""
}

testCaseTask "None"
<| fun () ->
task {
let expectedValue = 10
let taskOption = Task.singleton None
let! result = TaskOption.defaultValue expectedValue taskOption
Expect.equal result expectedValue ""
}
]

let defaultWithTests =
testList "TaskOption.defaultWith Tests" [
testCaseTask "Some"
<| fun () ->
task {
let defaultValue = 10
let expectedValue = 5

let taskOption = TaskOption.retn expectedValue
let! result = TaskOption.defaultWith (fun () -> defaultValue) taskOption
Expect.equal result expectedValue ""
}

testCaseTask "None"
<| fun () ->
task {
let expectedValue = 10
let taskOption = Task.singleton None
let! result = TaskOption.defaultWith (fun () -> expectedValue) taskOption
Expect.equal result expectedValue ""
}
]

let allTests =
testList "Task Option Tests" [
mapTests
Expand All @@ -162,4 +208,6 @@ let allTests =
retnTests
taskOptionOperatorTests
eitherTests
defaultValueTests
defaultWithTests
]
44 changes: 44 additions & 0 deletions tests/FsToolkit.ErrorHandling.Tests/AsyncOption.fs
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,48 @@ let eitherTests =
}
]

let defaultValueTests =
testList "TaskOption.defaultValue Tests" [
testCaseAsync "Some"
<| async {
let defaultValue = 10
let expectedValue = 5

let asyncOption = AsyncOption.retn expectedValue
let! result = AsyncOption.defaultValue defaultValue asyncOption
Expect.equal result expectedValue ""
}

testCaseAsync "None"
<| async {
let expectedValue = 10
let asyncOption = Async.singleton None
let! result = AsyncOption.defaultValue expectedValue asyncOption
Expect.equal result expectedValue ""
}
]

let defaultWithTests =
testList "AsyncOption.defaultWith Tests" [
testCaseAsync "Some"
<| async {
let defaultValue = 10
let expectedValue = 5

let asyncOption = AsyncOption.retn expectedValue
let! result = AsyncOption.defaultWith (fun () -> defaultValue) asyncOption
Expect.equal result expectedValue ""
}

testCaseAsync "None"
<| async {
let expectedValue = 10
let asyncOption = Async.singleton None
let! result = AsyncOption.defaultWith (fun () -> expectedValue) asyncOption
Expect.equal result expectedValue ""
}
]

let allTests =
testList "Async Option Tests" [
mapTests
Expand All @@ -135,4 +177,6 @@ let allTests =
retnTests
asyncOptionOperatorTests
eitherTests
defaultValueTests
defaultWithTests
]