Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
fsharp.fio
Advanced tools
fsharp.fio - npm Package Compare versions
Package was removed
Sorry, it seems this package was removed from the registry
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
| <?xml version="1.0" encoding="utf-8"?> | ||
| <doc> | ||
| <assembly><name>FSharp.FIO</name></assembly> | ||
| <members> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ZipError``3(FSharp.FIO.DSL.Core.FIO{`0,``2})"> | ||
| <summary> | ||
| Combines two effects and succeeds with a tuple of their errors when both complete. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The effect to zip errors with this effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the errors or the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Zip``3(FSharp.FIO.DSL.Core.FIO{``1,`1})"> | ||
| <summary> | ||
| Combines two effects and succeeds with a tuple of their results when both complete. Errors are immediately returned if any effect fails. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to zip with this effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the results or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ThenError``3(FSharp.FIO.DSL.Core.FIO{`0,``2})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the error of the first effect. If the first effect succeeds, the result is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="eff">The effect to sequence after the first error.</param> | ||
| <returns>An FIO effect that sequences the two effects, returning the result or the error of the second effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Then``3(FSharp.FIO.DSL.Core.FIO{``1,`1})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the result of the first effect. If the first effect fails, the error is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to sequence after the first.</param> | ||
| <returns>An FIO effect that sequences the two effects, returning the result of the second or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Succeed``2(`0)"> | ||
| <summary> | ||
| Succeeds immediately with the provided result value. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="res">The result value to succeed with.</param> | ||
| <returns>An FIO effect that succeeds with the given result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ParallelError``3(FSharp.FIO.DSL.Core.FIO{`0,``2})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their errors when both complete. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The effect to run in parallel with this effect for errors.</param> | ||
| <returns>An FIO effect that returns a tuple of the errors or the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Parallel``3(FSharp.FIO.DSL.Core.FIO{``1,`1})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their results when both complete. If either effect fails, the error is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to run in parallel with this effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the results or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.MapError``3(Microsoft.FSharp.Core.FSharpFunc{`1,``2})"> | ||
| <summary> | ||
| Maps a function over the error of an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="cont">The function to apply to the error.</param> | ||
| <returns>An FIO effect that applies the function to the error or returns the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Map``3(Microsoft.FSharp.Core.FSharpFunc{`0,``1})"> | ||
| <summary> | ||
| Maps a function over the result of an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The function to apply to the result.</param> | ||
| <returns>An FIO effect that applies the function to the result or returns an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task})"> | ||
| <summary> | ||
| Converts a Task into a Fiber with a default onError handler. | ||
| </summary> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Converts a Task into a Fiber. | ||
| </summary> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromResult``2(Microsoft.FSharp.Core.FSharpResult{`0,`1})"> | ||
| <summary> | ||
| Converts a Result value into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="res">The Result value to convert.</param> | ||
| <returns>An FIO effect that succeeds with the Ok value or fails with the Error value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromOption``2(Microsoft.FSharp.Core.FSharpOption{`0},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,`1})"> | ||
| <summary> | ||
| Converts an Option value into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="opt">The Option value to convert.</param> | ||
| <param name="onNone">A function to produce an error if the option is None.</param> | ||
| <returns>An FIO effect that succeeds with the Some value or fails with the error from onNone.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromGenericTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task{`0}})"> | ||
| <summary> | ||
| Converts a generic Task into a Fiber with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromGenericTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task{`0}},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Converts a generic Task into a Fiber. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromFunc``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,`0})"> | ||
| <summary> | ||
| Converts a function into an effect with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromFunc``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,`0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Converts a function into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromChoice``2(Microsoft.FSharp.Core.FSharpChoice{`0,`1})"> | ||
| <summary> | ||
| Converts a Choice value into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="choice">The Choice value to convert.</param> | ||
| <returns>An FIO effect that succeeds with the Choice1Of2 value or fails with the Choice2Of2 value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Fork``3"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns the fiber interpreting it. The fiber can be awaited for the result of the effect. | ||
| </summary> | ||
| <typeparam name="R">The result type of the fiber.</typeparam> | ||
| <typeparam name="E">The error type of the fiber.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <returns>An FIO effect that starts the effect in a new fiber and returns the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Fail``2(`1)"> | ||
| <summary> | ||
| Fails immediately with the provided error value. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="err">The error value to fail with.</param> | ||
| <returns>An FIO effect that fails with the given error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.BindError``3(Microsoft.FSharp.Core.FSharpFunc{`1,FSharp.FIO.DSL.Core.FIO{`0,``2}})"> | ||
| <summary> | ||
| Binds a continuation to the error of an effect. If the effect succeeds, the result is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="cont">The continuation function to apply to the error.</param> | ||
| <returns>An FIO effect that applies the continuation to the error or returns the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Bind``3(Microsoft.FSharp.Core.FSharpFunc{`0,FSharp.FIO.DSL.Core.FIO{``1,`1}})"> | ||
| <summary> | ||
| Binds a continuation to the result of an effect. If the effect fails, the error is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The continuation function to apply to the result.</param> | ||
| <returns>An FIO effect that applies the continuation to the result or returns an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitTask``2(System.Threading.Tasks.Task)"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect with a default onError handler. | ||
| </summary> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitTask``2(System.Threading.Tasks.Task,Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect. | ||
| </summary> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitGenericTask``2(System.Threading.Tasks.Task{`0})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitGenericTask``2(System.Threading.Tasks.Task{`0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitAsync``2(Microsoft.FSharp.Control.FSharpAsync{`0})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitAsync``2(Microsoft.FSharp.Control.FSharpAsync{`0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ApplyError``3(FSharp.FIO.DSL.Core.FIO{`0,Microsoft.FSharp.Core.FSharpFunc{`1,``2}})"> | ||
| <summary> | ||
| Combines two effects: one produces an error function and the other produces an error value. The function is applied to the value, and the error is returned. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="eff">The effect producing a function to apply to the error.</param> | ||
| <returns>An FIO effect that applies the function to the error or returns the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Apply``3(FSharp.FIO.DSL.Core.FIO{Microsoft.FSharp.Core.FSharpFunc{`0,``1},`1})"> | ||
| <summary> | ||
| Combines two effects: one produces a result function and the other produces a result value. The function is applied to the value, and the result is returned. Errors are immediately returned if any effect fails. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect producing a function to apply.</param> | ||
| <returns>An FIO effect that applies the function to the result or returns an error.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core.FIO`2"> | ||
| <summary> | ||
| Builds a functional effect that can either succeed with a result or fail with an error when interpreted by a runtime. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.Core.Channel`1.Id"> | ||
| <summary> | ||
| Gets the unique identifier of the channel. | ||
| </summary> | ||
| <returns>The unique Guid of the channel.</returns> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.Core.Channel`1.Count"> | ||
| <summary> | ||
| Gets the number of messages currently in the channel. | ||
| </summary> | ||
| <returns>The number of messages in the channel.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Channel`1.Send``2(`0)"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with the message. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="msg">The message to send.</param> | ||
| <returns>An FIO effect that sends the message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Channel`1.Receive``2"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with it. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <returns>An FIO effect that receives a message from the channel or returns an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Channel`1.#ctor"> | ||
| <summary> | ||
| Creates a new channel with a unique identifier. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core.Channel`1"> | ||
| <summary> | ||
| A Channel represents a communication queue that holds data of type 'R. | ||
| Data can be sent to and received (blocking) from a channel. | ||
| </summary> | ||
| <typeparam name="R">The type of data held by the channel.</typeparam> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.Core.Fiber`2.Id"> | ||
| <summary> | ||
| Gets the unique identifier of the fiber. | ||
| </summary> | ||
| <returns>The unique Guid of the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Fiber`2.Task``2"> | ||
| <summary> | ||
| Waits for the fiber and succeeds with its result, returning a Task. | ||
| </summary> | ||
| <returns>A Task that completes with the result or error of the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Fiber`2.Await``2"> | ||
| <summary> | ||
| Creates an effect that waits for the fiber and succeeds with its result. | ||
| </summary> | ||
| <returns>An FIO effect that waits for the fiber and returns its result or error.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core.Fiber`2"> | ||
| <summary> | ||
| A Fiber represents a lightweight, cooperative thread of execution. | ||
| Fibers are used to interpret multiple effects in parallel and can be awaited to retrieve the result of the effect. | ||
| </summary> | ||
| <typeparam name="R">The result type of the fiber.</typeparam> | ||
| <typeparam name="E">The error type of the fiber.</typeparam> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core"> | ||
| <summary> | ||
| Provides the core types, primitives, and internal machinery for the FIO effect system, including FIO, Fiber, Channel, and supporting types for effectful, concurrent, and asynchronous programming in F#. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Zero``1"> | ||
| <summary> | ||
| Returns an FIO effect that succeeds with unit. Used for empty computation expressions. | ||
| </summary> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <returns>An FIO effect that succeeds with unit.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.YieldFromFinal``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Returns the given FIO effect. Used for yield! expressions as the final operation. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to yield from.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.YieldFrom``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Returns the given FIO effect. Used for yield! expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to yield from.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Yield``2(``0)"> | ||
| <summary> | ||
| Returns an FIO effect that succeeds with the given value. Used for yield expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="res">The value to yield.</param> | ||
| <returns>An FIO effect that succeeds with the given value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.While``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Boolean},FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Repeatedly runs the body while the guard returns true. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="guard">A function that returns true to continue looping.</param> | ||
| <param name="body">The FIO effect to run each iteration.</param> | ||
| <returns>An FIO effect that loops while the guard is true.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Using``3(``0,Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}})"> | ||
| <summary> | ||
| Uses a disposable resource in a computation expression, ensuring it is disposed after use. | ||
| </summary> | ||
| <typeparam name="'T">The type of the resource.</typeparam> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="resource">The disposable resource to use.</param> | ||
| <param name="body">The function to run with the resource.</param> | ||
| <returns>An FIO effect that uses and disposes the resource.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.TryWith``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``1,FSharp.FIO.DSL.Core.FIO{``0,``2}})"> | ||
| <summary> | ||
| Handles exceptions in an FIO effect by binding the error to a handler. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <typeparam name="'E1">The new error type after handling.</typeparam> | ||
| <param name="eff">The FIO effect to try.</param> | ||
| <param name="cont">The error handler function.</param> | ||
| <returns>An FIO effect that handles errors using the given handler.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.TryFinally``2(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,Microsoft.FSharp.Core.Unit})"> | ||
| <summary> | ||
| Ensures a finalizer is run after an FIO effect, even if an exception occurs. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type (must be an exception type).</typeparam> | ||
| <param name="eff">The FIO effect to try.</param> | ||
| <param name="finalizer">The finalizer function to run after the effect.</param> | ||
| <returns>An FIO effect that runs the finalizer after the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Run``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Runs the given FIO effect. Used to mark the end of a computation expression. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to run.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.ReturnFromFinal``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Returns the given FIO effect. Used to return an effect from a computation expression as the final operation. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to return.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.ReturnFrom``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Returns the given FIO effect. Used to return an effect from a computation expression. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to return.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Return``2(``0)"> | ||
| <summary> | ||
| Returns an FIO effect that succeeds with the given value. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="res">The value to return.</param> | ||
| <returns>An FIO effect that succeeds with the given value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.MergeSources``3(FSharp.FIO.DSL.Core.FIO{``0,``2},FSharp.FIO.DSL.Core.FIO{``1,``2})"> | ||
| <summary> | ||
| Merges two FIO effects into one that returns a tuple of their results. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The first FIO effect.</param> | ||
| <param name="eff'">The second FIO effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the results.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Match``3(``2,Microsoft.FSharp.Core.FSharpFunc{``2,FSharp.FIO.DSL.Core.FIO{``0,``1}})"> | ||
| <summary> | ||
| Pattern matches on a value and runs the corresponding FIO effect. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <typeparam name="'T">The type of the value to match on.</typeparam> | ||
| <param name="value">The value to match on.</param> | ||
| <param name="cases">A function that returns the FIO effect for each case.</param> | ||
| <returns>An FIO effect representing the matched case.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.For``2(System.Collections.Generic.IEnumerable{``0},Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{Microsoft.FSharp.Core.Unit,``1}})"> | ||
| <summary> | ||
| Iterates over a sequence, running the body for each element in order. | ||
| </summary> | ||
| <typeparam name="'T">The element type of the sequence.</typeparam> | ||
| <typeparam name="'E">The error type (must be an exception type).</typeparam> | ||
| <param name="sequence">The sequence to iterate over.</param> | ||
| <param name="body">The function to run for each element.</param> | ||
| <returns>An FIO effect that runs the body for each element in the sequence.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Delay``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,FSharp.FIO.DSL.Core.FIO{``0,``1}})"> | ||
| <summary> | ||
| Delays the execution of a computation until it is needed. | ||
| </summary> | ||
| <typeparam name="'R1">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="cont">A function that produces the FIO effect to run.</param> | ||
| <returns>An FIO effect that delays execution.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Combine``3(FSharp.FIO.DSL.Core.FIO{``0,``2},FSharp.FIO.DSL.Core.FIO{``1,``2})"> | ||
| <summary> | ||
| Combines two FIO effects, sequencing them in computation expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The first FIO effect.</param> | ||
| <param name="eff'">The second FIO effect to run after the first.</param> | ||
| <returns>An FIO effect representing the sequential composition.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.BindReturn``3(FSharp.FIO.DSL.Core.FIO{``0,``2},Microsoft.FSharp.Core.FSharpFunc{``0,``1})"> | ||
| <summary> | ||
| Binds the result of an FIO effect to a function, mapping the result in computation expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The mapped result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to bind.</param> | ||
| <param name="cont">The function to apply to the result.</param> | ||
| <returns>An FIO effect representing the mapped computation.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Bind``3(FSharp.FIO.DSL.Core.FIO{``0,``2},Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}})"> | ||
| <summary> | ||
| Binds the result of an FIO effect to a continuation, enabling sequential composition in computation expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The result type of the continuation effect.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to bind.</param> | ||
| <param name="cont">The continuation function to apply to the result.</param> | ||
| <returns>An FIO effect representing the composed computation.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.CE.FIOBuilder"> | ||
| <summary> | ||
| The computation expression builder for FIO effects, enabling F# computation expression syntax (fio { ... }) for composing functional effects. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.CE.fio"> | ||
| <summary> | ||
| The FIO computation expression builder instance. Enables the use of `fio { ... }` syntax for composing FIO effects. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.CE"> | ||
| <summary> | ||
| Provides the computation expression builder for FIO, enabling idiomatic F# computation expression syntax (fio { ... }) for composing functional effects. | ||
| Includes the FIOBuilder type and the fio instance for effectful workflows. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessHatHatGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Combines the errors of two effects into a tuple when both fail. | ||
| Alias for <c>FIO.ZipError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that combines the errors of the given effects into a tuple.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessHatGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Combines the results of two effects into a tuple when both succeed. | ||
| If either effect fails, the error is immediately returned. Alias for <c>FIO.Zip</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that combines the results of the given effects into a tuple.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMultiplyMultiplyGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``2}})"> | ||
| <summary> | ||
| Combines two effects: one producing a function and the other a value, | ||
| and applies the function to the value. Alias for <c>FIO.ApplyError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <typeparam name="E1">The error type of the function.</typeparam> | ||
| <param name="eff">The effect producing the function.</param> | ||
| <param name="eff'">The effect producing the value.</param> | ||
| <returns>An FIO effect that combines the given effects and applies the function to the value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMultiplyGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{Microsoft.FSharp.Core.FSharpFunc{``0,``2},``1})"> | ||
| <summary> | ||
| Combines two effects: one producing a function and the other a value, | ||
| and applies the function to the value. Alias for <c>FIO.Apply</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the function.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect producing the function.</param> | ||
| <param name="eff'">The effect producing the value.</param> | ||
| <returns>An FIO effect that combines the given effects and applies the function to the value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_QmarkLessLess``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the error of the first one. Alias for <c>FIO.ThenError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the error of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_GreaterGreaterQmark``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the error of the first one. Alias for <c>FIO.ThenError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the error of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_ComposeLeft``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the result of the first one. Alias for <c>FIO.Then</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the result of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_ComposeRight``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the result of the first one. Alias for <c>FIO.Then</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the result of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_QmarkLessMultiply``3(Microsoft.FSharp.Core.FSharpFunc{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``0})"> | ||
| <summary> | ||
| Maps a function over the error of an effect. Alias for <c>FIO.MapError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the mapped function.</typeparam> | ||
| <param name="cont">The function to apply.</param> | ||
| <param name="eff">The effect to map.</param> | ||
| <returns>An FIO effect that maps the given function over the error of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MultiplyGreaterQmark``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``1,``2})"> | ||
| <summary> | ||
| Maps a function over the error of an effect. Alias for <c>FIO.MapError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the mapped function.</typeparam> | ||
| <param name="eff">The effect to map.</param> | ||
| <param name="cont">The function to apply.</param> | ||
| <returns>An FIO effect that maps the given function over the error of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMultiply``3(Microsoft.FSharp.Core.FSharpFunc{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Maps a function over the result of an effect. Alias for <c>FIO.Map</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the mapped function.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The function to apply.</param> | ||
| <param name="eff">The effect to map.</param> | ||
| <returns>An FIO effect that maps the given function over the result of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MultiplyGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``0,``2})"> | ||
| <summary> | ||
| Maps a function over the result of an effect. Alias for <c>FIO.Map</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the mapped function.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to map.</param> | ||
| <param name="cont">The function to apply.</param> | ||
| <returns>An FIO effect that maps the given function over the result of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_QmarkEqualsLessLess``3(Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}},FSharp.FIO.DSL.Core.FIO{``1,``0})"> | ||
| <summary> | ||
| Chains the error result of the effect to the continuation function. Alias for <c>FIO.BindError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the continuation.</typeparam> | ||
| <param name="cont">The continuation function.</param> | ||
| <param name="eff">The effect to bind.</param> | ||
| <returns>An FIO effect that chains the error result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_GreaterGreaterEqualsQmark``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``1,FSharp.FIO.DSL.Core.FIO{``0,``2}})"> | ||
| <summary> | ||
| Chains the error result of the effect to the continuation function. Alias for <c>FIO.BindError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the continuation.</typeparam> | ||
| <param name="eff">The effect to bind.</param> | ||
| <param name="cont">The continuation function.</param> | ||
| <returns>An FIO effect that chains the error result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_EqualsLessLess``3(Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Chains the success result of the effect to the continuation function. Alias for <c>FIO.Bind</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the continuation.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The continuation function.</param> | ||
| <param name="eff">The effect to bind.</param> | ||
| <returns>An FIO effect that chains the success result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_GreaterGreaterEquals``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``2,``1}})"> | ||
| <summary> | ||
| Chains the success result of the effect to the continuation function. Alias for <c>FIO.Bind</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the continuation.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to bind.</param> | ||
| <param name="cont">The continuation function.</param> | ||
| <returns>An FIO effect that chains the success result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessLessLessTwiddle``2(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,``1})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect, applying error handling if necessary. Alias for <c>FIO.AwaitAsync</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessLessTwiddle``1(Microsoft.FSharp.Control.FSharpAsync{``0})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect with a default onError. Alias for <c>FIO.AwaitAsync</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessLessTwiddleTwiddle``1(System.Threading.Tasks.Task{``0})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect. Alias for <c>FIO.AwaitGenericTask</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessTwiddleTwiddle``2(System.Threading.Tasks.Task{``0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,``1})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect, applying error handling if necessary. Alias for <c>FIO.AwaitGenericTask</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessLessTwiddle(System.Threading.Tasks.Task)"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect. Alias for <c>FIO.AwaitTask</c>. | ||
| </summary> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessTwiddle``1(System.Threading.Tasks.Task,Microsoft.FSharp.Core.FSharpFunc{System.Exception,``0})"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect, applying error handling if necessary. Alias for <c>FIO.AwaitTask</c>. | ||
| </summary> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangTwiddleTwiddleGreater``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the completion of the fiber and returns `unit`. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessTwiddleTwiddle``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the completion of the fiber and returns `unit`. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangTwiddleTwiddleGreater``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the result of the given fiber and succeeds with it. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns its result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessTwiddleTwiddle``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the result of the given fiber and succeeds with it. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns its result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessBangBangGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their errors when both fail. | ||
| Alias for <c>FIO.ParallelError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that interprets both effects concurrently and returns a tuple of their errors.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessTwiddleGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with `unit` when completed. | ||
| If either effect fails, the error is immediately returned. Alias for <c>FIO.Parallel</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that interprets both effects concurrently and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessBangGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their results when both complete. | ||
| If either effect fails, the error is immediately returned. Alias for <c>FIO.Parallel</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that interprets both effects concurrently and returns a tuple of their results.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangTwiddleGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns `unit` when interpreted. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessTwiddle``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns `unit` when interpreted. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangTwiddleGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns the fiber that is interpreting it. | ||
| The fiber can be awaited for the result of the effect. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessTwiddle``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns the fiber that is interpreting it. | ||
| The fiber can be awaited for the result of the effect. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessBangMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with unit. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangMinusMinusBangGreater``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with unit. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with it. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangMinusMinusGreater``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with it. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessBangMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0},``0)"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with unit. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to send to.</param> | ||
| <param name="msg">The message to send.</param> | ||
| <returns>An FIO effect that sends the message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MinusMinusBangGreater``2(``0,FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with unit. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="msg">The message to send.</param> | ||
| <param name="chan">The channel to send to.</param> | ||
| <returns>An FIO effect that sends the message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0},``0)"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with the message. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to send to.</param> | ||
| <param name="msg">The message to send.</param> | ||
| <returns>An FIO effect that sends the message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MinusMinusGreater``2(``0,FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with the message. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="msg">The message to send.</param> | ||
| <param name="chan">The channel to send to.</param> | ||
| <returns>An FIO effect that sends the message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLess``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,``0})"> | ||
| <summary> | ||
| Succeeds with the result of a function and fails with Exception. Alias for <c>FIO.FromFunc</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessLess``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,``0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,``1})"> | ||
| <summary> | ||
| Succeeds with the result of a function and applies error handling if necessary. Alias for <c>FIO.FromFunc</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangMinus``2(``0)"> | ||
| <summary> | ||
| Fails immediately with the given error. Alias for <c>FIO.Fail</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="err">The error value to fail with.</param> | ||
| <returns>An FIO effect that fails with the given error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangPlus``2(``0)"> | ||
| <summary> | ||
| Succeeds immediately with the given result. Alias for <c>FIO.Succeed</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="res">The result value to succeed with.</param> | ||
| <returns>An FIO effect that succeeds with the given result.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Ops"> | ||
| <summary> | ||
| Provides functional operators and aliases for FIO effects, enabling idiomatic and expressive functional programming with FIO. | ||
| Includes combinators for sequencing, mapping, error handling, concurrency, and channel operations. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.Runtime.FWorkerRuntime.GetWorkerConfiguration"> | ||
| <summary> | ||
| Gets the worker configuration. | ||
| </summary> | ||
| <returns>The worker configuration.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.FWorkerRuntime"> | ||
| <summary> | ||
| Represents a functional worker runtime for interpreting FIO effects. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.WorkerConfig"> | ||
| <summary> | ||
| Represents the configuration for a worker runtime. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.FIO.Runtime.FRuntime.Name"> | ||
| <summary> | ||
| Gets the name of the runtime. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.FIO.Runtime.FRuntime.ConfigString"> | ||
| <summary> | ||
| Gets the configuration string for the runtime. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.Runtime.FRuntime.ToFileString"> | ||
| <summary> | ||
| Gets a file-friendly string representation of the runtime. | ||
| </summary> | ||
| <returns>A string suitable for file names.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.Runtime.FRuntime.Run``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Runs an FIO effect and returns a fiber representing its execution. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to run.</param> | ||
| <returns>A fiber representing the running effect.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.FRuntime"> | ||
| <summary> | ||
| Represents a functional runtime for interpreting FIO effects. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Direct.Runtime"> | ||
| <summary> | ||
| Represents the direct runtime for FIO, interpreting effects on the current thread. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Direct"> | ||
| <summary> | ||
| Provides the direct runtime for interpreting FIO effects, executing effects on the current thread. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Cooperative.Runtime"> | ||
| <summary> | ||
| Represents the cooperative runtime for FIO, interpreting effects concurrently using work-stealing and multiple workers. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Cooperative"> | ||
| <summary> | ||
| Provides the cooperative (work-stealing) runtime for interpreting FIO effects, enabling concurrent and asynchronous execution across multiple workers. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Concurrent.Runtime"> | ||
| <summary> | ||
| Represents the concurrent runtime for FIO, interpreting effects using event-driven concurrency and advanced scheduling. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Concurrent"> | ||
| <summary> | ||
| Provides the concurrent (advanced, event-driven) runtime for interpreting FIO effects, enabling scalable and highly concurrent execution. | ||
| </summary> | ||
| </member> | ||
| </members> | ||
| </doc> |
Sorry, the diff of this file is not supported yet
@@ -6,6 +6,6 @@ <?xml version="1.0" encoding="utf-8"?> | ||
| <Default Extension="dll" ContentType="application/octet" /> | ||
| <Default Extension="xml" ContentType="application/octet" /> | ||
| <Default Extension="png" ContentType="application/octet" /> | ||
| <Default Extension="md" ContentType="application/octet" /> | ||
| <Default Extension="nuspec" ContentType="application/octet" /> | ||
| <Default Extension="png" ContentType="application/octet" /> | ||
| <Default Extension="xml" ContentType="application/octet" /> | ||
| </Types> |
@@ -5,3 +5,3 @@ <?xml version="1.0" encoding="utf-8"?> | ||
| <id>FSharp.FIO</id> | ||
| <version>0.0.31-alpha</version> | ||
| <version>0.0.32-alpha</version> | ||
| <title>FSharp.FIO</title> | ||
@@ -16,6 +16,6 @@ <authors>FSharp.FIO</authors> | ||
| <description>FIO is a type-safe, purely functional effect system for F#, designed for building highly concurrent and asynchronous applications. It provides a lightweight DSL for writing composable programs using functional effects.</description> | ||
| <repository type="git" url="https://github.com/fs-fio/FIO" commit="a62dd0f32a1330f884a8b7c757c2dcb234214817" /> | ||
| <repository type="git" url="https://github.com/fs-fio/FIO" commit="be4378df423405adf0c270b185dce6cdde371479" /> | ||
| <dependencies> | ||
| <group targetFramework="net9.0"> | ||
| <dependency id="FSharp.Core" version="9.0.300" exclude="Build,Analyzers" /> | ||
| <group targetFramework="net10.0"> | ||
| <dependency id="FSharp.Core" version="10.0.101" exclude="Build,Analyzers" /> | ||
| </group> | ||
@@ -22,0 +22,0 @@ </dependencies> |
+0
-0
@@ -0,0 +0,0 @@ The MIT License (MIT) |
+0
-0
@@ -0,0 +0,0 @@ <a id="readme-top"></a> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
| <?xml version="1.0" encoding="utf-8"?> | ||
| <doc> | ||
| <assembly><name>FSharp.FIO</name></assembly> | ||
| <members> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ZipError``3(FSharp.FIO.DSL.Core.FIO{`0,``2})"> | ||
| <summary> | ||
| Combines two effects and succeeds with a tuple of their errors when both complete. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The effect to zip errors with this effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the errors or the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Zip``3(FSharp.FIO.DSL.Core.FIO{``1,`1})"> | ||
| <summary> | ||
| Combines two effects and succeeds with a tuple of their results when both complete. Errors are immediately returned if any effect fails. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to zip with this effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the results or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ThenError``3(FSharp.FIO.DSL.Core.FIO{`0,``2})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the error of the first effect. If the first effect succeeds, the result is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="eff">The effect to sequence after the first error.</param> | ||
| <returns>An FIO effect that sequences the two effects, returning the result or the error of the second effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Then``3(FSharp.FIO.DSL.Core.FIO{``1,`1})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the result of the first effect. If the first effect fails, the error is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to sequence after the first.</param> | ||
| <returns>An FIO effect that sequences the two effects, returning the result of the second or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Succeed``2(`0)"> | ||
| <summary> | ||
| Succeeds immediately with the provided result value. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="res">The result value to succeed with.</param> | ||
| <returns>An FIO effect that succeeds with the given result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ParallelError``3(FSharp.FIO.DSL.Core.FIO{`0,``2})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their errors when both complete. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The effect to run in parallel with this effect for errors.</param> | ||
| <returns>An FIO effect that returns a tuple of the errors or the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Parallel``3(FSharp.FIO.DSL.Core.FIO{``1,`1})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their results when both complete. If either effect fails, the error is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to run in parallel with this effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the results or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.MapError``3(Microsoft.FSharp.Core.FSharpFunc{`1,``2})"> | ||
| <summary> | ||
| Maps a function over the error of an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="cont">The function to apply to the error.</param> | ||
| <returns>An FIO effect that applies the function to the error or returns the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Map``3(Microsoft.FSharp.Core.FSharpFunc{`0,``1})"> | ||
| <summary> | ||
| Maps a function over the result of an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The function to apply to the result.</param> | ||
| <returns>An FIO effect that applies the function to the result or returns an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task})"> | ||
| <summary> | ||
| Converts a Task into a Fiber with a default onError handler. | ||
| </summary> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Converts a Task into a Fiber. | ||
| </summary> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromResult``2(Microsoft.FSharp.Core.FSharpResult{`0,`1})"> | ||
| <summary> | ||
| Converts a Result value into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="res">The Result value to convert.</param> | ||
| <returns>An FIO effect that succeeds with the Ok value or fails with the Error value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromOption``2(Microsoft.FSharp.Core.FSharpOption{`0},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,`1})"> | ||
| <summary> | ||
| Converts an Option value into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="opt">The Option value to convert.</param> | ||
| <param name="onNone">A function to produce an error if the option is None.</param> | ||
| <returns>An FIO effect that succeeds with the Some value or fails with the error from onNone.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromGenericTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task{`0}})"> | ||
| <summary> | ||
| Converts a generic Task into a Fiber with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromGenericTask``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Threading.Tasks.Task{`0}},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Converts a generic Task into a Fiber. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="lazyTask">A function that produces the Task to run.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that starts the Task in a Fiber and returns the Fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromFunc``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,`0})"> | ||
| <summary> | ||
| Converts a function into an effect with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromFunc``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,`0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Converts a function into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.FromChoice``2(Microsoft.FSharp.Core.FSharpChoice{`0,`1})"> | ||
| <summary> | ||
| Converts a Choice value into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="choice">The Choice value to convert.</param> | ||
| <returns>An FIO effect that succeeds with the Choice1Of2 value or fails with the Choice2Of2 value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Fork``3"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns the fiber interpreting it. The fiber can be awaited for the result of the effect. | ||
| </summary> | ||
| <typeparam name="R">The result type of the fiber.</typeparam> | ||
| <typeparam name="E">The error type of the fiber.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <returns>An FIO effect that starts the effect in a new fiber and returns the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Fail``2(`1)"> | ||
| <summary> | ||
| Fails immediately with the provided error value. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="err">The error value to fail with.</param> | ||
| <returns>An FIO effect that fails with the given error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.BindError``3(Microsoft.FSharp.Core.FSharpFunc{`1,FSharp.FIO.DSL.Core.FIO{`0,``2}})"> | ||
| <summary> | ||
| Binds a continuation to the error of an effect. If the effect succeeds, the result is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="cont">The continuation function to apply to the error.</param> | ||
| <returns>An FIO effect that applies the continuation to the error or returns the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Bind``3(Microsoft.FSharp.Core.FSharpFunc{`0,FSharp.FIO.DSL.Core.FIO{``1,`1}})"> | ||
| <summary> | ||
| Binds a continuation to the result of an effect. If the ef½fect fails, the error is immediately returned. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The continuation function to apply to the result.</param> | ||
| <returns>An FIO effect that applies the continuation to the result or returns an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitTask``2(System.Threading.Tasks.Task)"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect with a default onError handler. | ||
| </summary> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitTask``2(System.Threading.Tasks.Task,Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect. | ||
| </summary> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitGenericTask``2(System.Threading.Tasks.Task{`0})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitGenericTask``2(System.Threading.Tasks.Task{`0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitAsync``2(Microsoft.FSharp.Control.FSharpAsync{`0})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect with a default onError handler. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.AwaitAsync``2(Microsoft.FSharp.Control.FSharpAsync{`0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,`1})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.ApplyError``3(FSharp.FIO.DSL.Core.FIO{`0,Microsoft.FSharp.Core.FSharpFunc{`1,``2}})"> | ||
| <summary> | ||
| Combines two effects: one produces an error function and the other produces an error value. The function is applied to the value, and the error is returned. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the applied effect.</typeparam> | ||
| <typeparam name="E1">The error type.</typeparam> | ||
| <param name="eff">The effect producing a function to apply to the error.</param> | ||
| <returns>An FIO effect that applies the function to the error or returns the result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.FIO`2.Apply``3(FSharp.FIO.DSL.Core.FIO{Microsoft.FSharp.Core.FSharpFunc{`0,``1},`1})"> | ||
| <summary> | ||
| Combines two effects: one produces a result function and the other produces a result value. The function is applied to the value, and the result is returned. Errors are immediately returned if any effect fails. | ||
| </summary> | ||
| <typeparam name="R">The result type of the applied effect.</typeparam> | ||
| <typeparam name="R1">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect producing a function to apply.</param> | ||
| <returns>An FIO effect that applies the function to the result or returns an error.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core.FIO`2"> | ||
| <summary> | ||
| Builds a functional effect that can either succeed with a result or fail with an error when interpreted by a runtime. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.Core.Channel`1.Id"> | ||
| <summary> | ||
| Gets the unique identifier of the channel. | ||
| </summary> | ||
| <returns>The unique Guid of the channel.</returns> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.Core.Channel`1.Count"> | ||
| <summary> | ||
| Gets the number of messages currently in the channel. | ||
| </summary> | ||
| <returns>The number of messages in the channel.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Channel`1.Send``2(`0)"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with the message. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="msg">The message to send.</param> | ||
| <returns>An FIO effect that sends the message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Channel`1.Receive``2"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with it. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <returns>An FIO effect that receives a message from the channel or returns an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Channel`1.#ctor"> | ||
| <summary> | ||
| Creates a new channel with a unique identifier. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core.Channel`1"> | ||
| <summary> | ||
| A Channel represents a communication queue that holds data of type 'R. | ||
| Data can be sent to and received (blocking) from a channel. | ||
| </summary> | ||
| <typeparam name="R">The type of data held by the channel.</typeparam> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.Core.Fiber`2.Id"> | ||
| <summary> | ||
| Gets the unique identifier of the fiber. | ||
| </summary> | ||
| <returns>The unique Guid of the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Fiber`2.Task``2"> | ||
| <summary> | ||
| Waits for the fiber and succeeds with its result, returning a Task. | ||
| </summary> | ||
| <returns>A Task that completes with the result or error of the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Core.Fiber`2.Await``2"> | ||
| <summary> | ||
| Creates an effect that waits for the fiber and succeeds with its result. | ||
| </summary> | ||
| <returns>An FIO effect that waits for the fiber and returns its result or error.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core.Fiber`2"> | ||
| <summary> | ||
| A Fiber represents a lightweight, cooperative thread of execution. | ||
| Fibers are used to interpret multiple effects in parallel and can be awaited to retrieve the result of the effect. | ||
| </summary> | ||
| <typeparam name="R">The result type of the fiber.</typeparam> | ||
| <typeparam name="E">The error type of the fiber.</typeparam> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Core"> | ||
| <summary> | ||
| Provides the core types, primitives, and internal machinery for the FIO effect system, including FIO, Fiber, Channel, and supporting types for effectful, concurrent, and asynchronous programming in F#. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Zero``1"> | ||
| <summary> | ||
| Returns an FIO effect that succeeds with unit. Used for empty computation expressions. | ||
| </summary> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <returns>An FIO effect that succeeds with unit.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.YieldFrom``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Returns the given FIO effect. Used for yield! expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to yield from.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Yield``2(``0)"> | ||
| <summary> | ||
| Returns an FIO effect that succeeds with the given value. Used for yield expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="res">The value to yield.</param> | ||
| <returns>An FIO effect that succeeds with the given value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.While``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Boolean},FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Repeatedly runs the body while the guard returns true. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="guard">A function that returns true to continue looping.</param> | ||
| <param name="body">The FIO effect to run each iteration.</param> | ||
| <returns>An FIO effect that loops while the guard is true.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Using``3(``0,Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}})"> | ||
| <summary> | ||
| Uses a disposable resource in a computation expression, ensuring it is disposed after use. | ||
| </summary> | ||
| <typeparam name="'T">The type of the resource.</typeparam> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="resource">The disposable resource to use.</param> | ||
| <param name="body">The function to run with the resource.</param> | ||
| <returns>An FIO effect that uses and disposes the resource.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.TryWith``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``1,FSharp.FIO.DSL.Core.FIO{``0,``2}})"> | ||
| <summary> | ||
| Handles exceptions in an FIO effect by binding the error to a handler. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <typeparam name="'E1">The new error type after handling.</typeparam> | ||
| <param name="eff">The FIO effect to try.</param> | ||
| <param name="cont">The error handler function.</param> | ||
| <returns>An FIO effect that handles errors using the given handler.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.TryFinally``2(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,Microsoft.FSharp.Core.Unit})"> | ||
| <summary> | ||
| Ensures a finalizer is run after an FIO effect, even if an exception occurs. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type (must be an exception type).</typeparam> | ||
| <param name="eff">The FIO effect to try.</param> | ||
| <param name="finalizer">The finalizer function to run after the effect.</param> | ||
| <returns>An FIO effect that runs the finalizer after the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Run``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Runs the given FIO effect. Used to mark the end of a computation expression. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to run.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.ReturnFrom``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Returns the given FIO effect. Used to return an effect from a computation expression. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to return.</param> | ||
| <returns>The same FIO effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Return``2(``0)"> | ||
| <summary> | ||
| Returns an FIO effect that succeeds with the given value. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="res">The value to return.</param> | ||
| <returns>An FIO effect that succeeds with the given value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.MergeSources``3(FSharp.FIO.DSL.Core.FIO{``0,``2},FSharp.FIO.DSL.Core.FIO{``1,``2})"> | ||
| <summary> | ||
| Merges two FIO effects into one that returns a tuple of their results. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The first FIO effect.</param> | ||
| <param name="eff'">The second FIO effect.</param> | ||
| <returns>An FIO effect that returns a tuple of the results.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Match``3(``2,Microsoft.FSharp.Core.FSharpFunc{``2,FSharp.FIO.DSL.Core.FIO{``0,``1}})"> | ||
| <summary> | ||
| Pattern matches on a value and runs the corresponding FIO effect. | ||
| </summary> | ||
| <typeparam name="'R">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <typeparam name="'T">The type of the value to match on.</typeparam> | ||
| <param name="value">The value to match on.</param> | ||
| <param name="cases">A function that returns the FIO effect for each case.</param> | ||
| <returns>An FIO effect representing the matched case.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.For``2(System.Collections.Generic.IEnumerable{``0},Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{Microsoft.FSharp.Core.Unit,``1}})"> | ||
| <summary> | ||
| Iterates over a sequence, running the body for each element in order. | ||
| </summary> | ||
| <typeparam name="'T">The element type of the sequence.</typeparam> | ||
| <typeparam name="'E">The error type (must be an exception type).</typeparam> | ||
| <param name="sequence">The sequence to iterate over.</param> | ||
| <param name="body">The function to run for each element.</param> | ||
| <returns>An FIO effect that runs the body for each element in the sequence.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Delay``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,FSharp.FIO.DSL.Core.FIO{``0,``1}})"> | ||
| <summary> | ||
| Delays the execution of a computation until it is needed. | ||
| </summary> | ||
| <typeparam name="'R1">The result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="cont">A function that produces the FIO effect to run.</param> | ||
| <returns>An FIO effect that delays execution.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Combine``3(FSharp.FIO.DSL.Core.FIO{``0,``2},FSharp.FIO.DSL.Core.FIO{``1,``2})"> | ||
| <summary> | ||
| Combines two FIO effects, sequencing them in computation expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The first FIO effect.</param> | ||
| <param name="eff'">The second FIO effect to run after the first.</param> | ||
| <returns>An FIO effect representing the sequential composition.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.BindReturn``3(FSharp.FIO.DSL.Core.FIO{``0,``2},Microsoft.FSharp.Core.FSharpFunc{``0,``1})"> | ||
| <summary> | ||
| Binds the result of an FIO effect to a function, mapping the result in computation expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The mapped result type.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to bind.</param> | ||
| <param name="cont">The function to apply to the result.</param> | ||
| <returns>An FIO effect representing the mapped computation.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.CE.FIOBuilder.Bind``3(FSharp.FIO.DSL.Core.FIO{``0,``2},Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}})"> | ||
| <summary> | ||
| Binds the result of an FIO effect to a continuation, enabling sequential composition in computation expressions. | ||
| </summary> | ||
| <typeparam name="'R">The result type of the first effect.</typeparam> | ||
| <typeparam name="'R1">The result type of the continuation effect.</typeparam> | ||
| <typeparam name="'E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to bind.</param> | ||
| <param name="cont">The continuation function to apply to the result.</param> | ||
| <returns>An FIO effect representing the composed computation.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.CE.FIOBuilder"> | ||
| <summary> | ||
| The computation expression builder for FIO effects, enabling F# computation expression syntax (fio { ... }) for composing functional effects. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.FIO.DSL.CE.fio"> | ||
| <summary> | ||
| The FIO computation expression builder instance. Enables the use of `fio { ... }` syntax for composing FIO effects. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.CE"> | ||
| <summary> | ||
| Provides the computation expression builder for FIO, enabling idiomatic F# computation expression syntax (fio { ... }) for composing functional effects. | ||
| Includes the FIOBuilder type and the fio instance for effectful workflows. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessHatHatGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Combines the errors of two effects into a tuple when both fail. | ||
| Alias for <c>FIO.ZipError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that combines the errors of the given effects into a tuple.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessHatGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Combines the results of two effects into a tuple when both succeed. | ||
| If either effect fails, the error is immediately returned. Alias for <c>FIO.Zip</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that combines the results of the given effects into a tuple.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMultiplyMultiplyGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``2}})"> | ||
| <summary> | ||
| Combines two effects: one producing a function and the other a value, | ||
| and applies the function to the value. Alias for <c>FIO.ApplyError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <typeparam name="E1">The error type of the function.</typeparam> | ||
| <param name="eff">The effect producing the function.</param> | ||
| <param name="eff'">The effect producing the value.</param> | ||
| <returns>An FIO effect that combines the given effects and applies the function to the value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMultiplyGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{Microsoft.FSharp.Core.FSharpFunc{``0,``2},``1})"> | ||
| <summary> | ||
| Combines two effects: one producing a function and the other a value, | ||
| and applies the function to the value. Alias for <c>FIO.Apply</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the function.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect producing the function.</param> | ||
| <param name="eff'">The effect producing the value.</param> | ||
| <returns>An FIO effect that combines the given effects and applies the function to the value.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_QmarkLessLess``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the error of the first one. Alias for <c>FIO.ThenError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the error of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_GreaterGreaterQmark``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the error of the first one. Alias for <c>FIO.ThenError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the error of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_ComposeLeft``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the result of the first one. Alias for <c>FIO.Then</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the result of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_ComposeRight``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Sequences two effects, ignoring the result of the first one. Alias for <c>FIO.Then</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that sequences the given effects, ignoring the result of the first one.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_QmarkLessMultiply``3(Microsoft.FSharp.Core.FSharpFunc{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``0})"> | ||
| <summary> | ||
| Maps a function over the error of an effect. Alias for <c>FIO.MapError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the mapped function.</typeparam> | ||
| <param name="cont">The function to apply.</param> | ||
| <param name="eff">The effect to map.</param> | ||
| <returns>An FIO effect that maps the given function over the error of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MultiplyGreaterQmark``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``1,``2})"> | ||
| <summary> | ||
| Maps a function over the error of an effect. Alias for <c>FIO.MapError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the mapped function.</typeparam> | ||
| <param name="eff">The effect to map.</param> | ||
| <param name="cont">The function to apply.</param> | ||
| <returns>An FIO effect that maps the given function over the error of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMultiply``3(Microsoft.FSharp.Core.FSharpFunc{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Maps a function over the result of an effect. Alias for <c>FIO.Map</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the mapped function.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The function to apply.</param> | ||
| <param name="eff">The effect to map.</param> | ||
| <returns>An FIO effect that maps the given function over the result of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MultiplyGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``0,``2})"> | ||
| <summary> | ||
| Maps a function over the result of an effect. Alias for <c>FIO.Map</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the mapped function.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to map.</param> | ||
| <param name="cont">The function to apply.</param> | ||
| <returns>An FIO effect that maps the given function over the result of the effect.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_QmarkEqualsLessLess``3(Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}},FSharp.FIO.DSL.Core.FIO{``1,``0})"> | ||
| <summary> | ||
| Chains the error result of the effect to the continuation function. Alias for <c>FIO.BindError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the continuation.</typeparam> | ||
| <param name="cont">The continuation function.</param> | ||
| <param name="eff">The effect to bind.</param> | ||
| <returns>An FIO effect that chains the error result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_GreaterGreaterEqualsQmark``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``1,FSharp.FIO.DSL.Core.FIO{``0,``2}})"> | ||
| <summary> | ||
| Chains the error result of the effect to the continuation function. Alias for <c>FIO.BindError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="E">The error type of the effect.</typeparam> | ||
| <typeparam name="E1">The error type of the continuation.</typeparam> | ||
| <param name="eff">The effect to bind.</param> | ||
| <param name="cont">The continuation function.</param> | ||
| <returns>An FIO effect that chains the error result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_EqualsLessLess``3(Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``1,``2}},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Chains the success result of the effect to the continuation function. Alias for <c>FIO.Bind</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the continuation.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="cont">The continuation function.</param> | ||
| <param name="eff">The effect to bind.</param> | ||
| <returns>An FIO effect that chains the success result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_GreaterGreaterEquals``3(FSharp.FIO.DSL.Core.FIO{``0,``1},Microsoft.FSharp.Core.FSharpFunc{``0,FSharp.FIO.DSL.Core.FIO{``2,``1}})"> | ||
| <summary> | ||
| Chains the success result of the effect to the continuation function. Alias for <c>FIO.Bind</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the effect.</typeparam> | ||
| <typeparam name="R1">The result type of the continuation.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to bind.</param> | ||
| <param name="cont">The continuation function.</param> | ||
| <returns>An FIO effect that chains the success result of the given effect to the continuation function.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessLessLessTwiddle``2(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,``1})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect, applying error handling if necessary. Alias for <c>FIO.AwaitAsync</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessLessTwiddle``1(Microsoft.FSharp.Control.FSharpAsync{``0})"> | ||
| <summary> | ||
| Awaits an Async computation and turns it into an effect with a default onError. Alias for <c>FIO.AwaitAsync</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="async">The Async computation to await.</param> | ||
| <returns>An FIO effect that completes with the Async result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessLessTwiddleTwiddle``1(System.Threading.Tasks.Task{``0})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect. Alias for <c>FIO.AwaitGenericTask</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessTwiddleTwiddle``2(System.Threading.Tasks.Task{``0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,``1})"> | ||
| <summary> | ||
| Awaits a generic Task and turns it into an effect, applying error handling if necessary. Alias for <c>FIO.AwaitGenericTask</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes with the Task result or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessLessTwiddle(System.Threading.Tasks.Task)"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect. Alias for <c>FIO.AwaitTask</c>. | ||
| </summary> | ||
| <param name="task">The Task to await.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessTwiddle``1(System.Threading.Tasks.Task,Microsoft.FSharp.Core.FSharpFunc{System.Exception,``0})"> | ||
| <summary> | ||
| Awaits a Task and turns it into an effect, applying error handling if necessary. Alias for <c>FIO.AwaitTask</c>. | ||
| </summary> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="task">The Task to await.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that completes when the Task completes or fails with an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangTwiddleTwiddleGreater``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the completion of the fiber and returns `unit`. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessTwiddleTwiddle``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the completion of the fiber and returns `unit`. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangTwiddleTwiddleGreater``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the result of the given fiber and succeeds with it. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns its result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessTwiddleTwiddle``2(FSharp.FIO.DSL.Core.Fiber{``0,``1})"> | ||
| <summary> | ||
| Waits for the result of the given fiber and succeeds with it. Alias for <c>Fiber.Await</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="fiber">The fiber to await.</param> | ||
| <returns>An FIO effect that awaits the given fiber and returns its result.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessBangBangGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``0,``2})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their errors when both fail. | ||
| Alias for <c>FIO.ParallelError</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="E">The error type of the first effect.</typeparam> | ||
| <typeparam name="E1">The error type of the second effect.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that interprets both effects concurrently and returns a tuple of their errors.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessTwiddleGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with `unit` when completed. | ||
| If either effect fails, the error is immediately returned. Alias for <c>FIO.Parallel</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that interprets both effects concurrently and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessBangGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1},FSharp.FIO.DSL.Core.FIO{``2,``1})"> | ||
| <summary> | ||
| Interprets two effects concurrently and succeeds with a tuple of their results when both complete. | ||
| If either effect fails, the error is immediately returned. Alias for <c>FIO.Parallel</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type of the first effect.</typeparam> | ||
| <typeparam name="R1">The result type of the second effect.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The first effect.</param> | ||
| <param name="eff'">The second effect.</param> | ||
| <returns>An FIO effect that interprets both effects concurrently and returns a tuple of their results.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangTwiddleGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns `unit` when interpreted. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangBangLessTwiddle``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns `unit` when interpreted. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns `unit`.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangTwiddleGreater``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns the fiber that is interpreting it. | ||
| The fiber can be awaited for the result of the effect. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessTwiddle``3(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Interprets an effect concurrently and returns the fiber that is interpreting it. | ||
| The fiber can be awaited for the result of the effect. Alias for <c>FIO.Fork</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The effect to fork.</param> | ||
| <returns>An FIO effect that interprets the given effect concurrently and returns the fiber.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessBangMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with unit. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangMinusMinusBangGreater``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with unit. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with it. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangMinusMinusGreater``2(FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Receives a message from the channel and succeeds with it. Alias for <c>Channel.Receive</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to receive from.</param> | ||
| <returns>An FIO effect that receives a message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessBangMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0},``0)"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with unit. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to send to.</param> | ||
| <param name="msg">The message to send.</param> | ||
| <returns>An FIO effect that sends the message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MinusMinusBangGreater``2(``0,FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with unit. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="msg">The message to send.</param> | ||
| <param name="chan">The channel to send to.</param> | ||
| <returns>An FIO effect that sends the message and returns unit, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_LessMinusMinus``2(FSharp.FIO.DSL.Core.Channel{``0},``0)"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with the message. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="chan">The channel to send to.</param> | ||
| <param name="msg">The message to send.</param> | ||
| <returns>An FIO effect that sends the message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_MinusMinusGreater``2(``0,FSharp.FIO.DSL.Core.Channel{``0})"> | ||
| <summary> | ||
| Sends a message to the channel and succeeds with the message. Alias for <c>Channel.Send</c>. | ||
| </summary> | ||
| <typeparam name="R">The message type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="msg">The message to send.</param> | ||
| <param name="chan">The channel to send to.</param> | ||
| <returns>An FIO effect that sends the message and returns it, or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLess``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,``0})"> | ||
| <summary> | ||
| Succeeds with the result of a function and fails with Exception. Alias for <c>FIO.FromFunc</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an exception.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangLessLessLess``2(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,``0},Microsoft.FSharp.Core.FSharpFunc{System.Exception,``1})"> | ||
| <summary> | ||
| Succeeds with the result of a function and applies error handling if necessary. Alias for <c>FIO.FromFunc</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="func">The function to execute.</param> | ||
| <param name="onError">A function to map exceptions to the error type 'E.</param> | ||
| <returns>An FIO effect that executes the function and returns its result or an error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangMinus``2(``0)"> | ||
| <summary> | ||
| Fails immediately with the given error. Alias for <c>FIO.Fail</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="err">The error value to fail with.</param> | ||
| <returns>An FIO effect that fails with the given error.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.DSL.Ops.op_BangPlus``2(``0)"> | ||
| <summary> | ||
| Succeeds immediately with the given result. Alias for <c>FIO.Succeed</c>. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="res">The result value to succeed with.</param> | ||
| <returns>An FIO effect that succeeds with the given result.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.DSL.Ops"> | ||
| <summary> | ||
| Provides functional operators and aliases for FIO effects, enabling idiomatic and expressive functional programming with FIO. | ||
| Includes combinators for sequencing, mapping, error handling, concurrency, and channel operations. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.Runtime.FWorkerRuntime.GetWorkerConfiguration"> | ||
| <summary> | ||
| Gets the worker configuration. | ||
| </summary> | ||
| <returns>The worker configuration.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.FWorkerRuntime"> | ||
| <summary> | ||
| Represents a functional worker runtime for interpreting FIO effects. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.WorkerConfig"> | ||
| <summary> | ||
| Represents the configuration for a worker runtime. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.FIO.Runtime.FRuntime.Name"> | ||
| <summary> | ||
| Gets the name of the runtime. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.FIO.Runtime.FRuntime.ConfigString"> | ||
| <summary> | ||
| Gets the configuration string for the runtime. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.FIO.Runtime.FRuntime.ToFileString"> | ||
| <summary> | ||
| Gets a file-friendly string representation of the runtime. | ||
| </summary> | ||
| <returns>A string suitable for file names.</returns> | ||
| </member> | ||
| <member name="M:FSharp.FIO.Runtime.FRuntime.Run``2(FSharp.FIO.DSL.Core.FIO{``0,``1})"> | ||
| <summary> | ||
| Runs an FIO effect and returns a fiber representing its execution. | ||
| </summary> | ||
| <typeparam name="R">The result type.</typeparam> | ||
| <typeparam name="E">The error type.</typeparam> | ||
| <param name="eff">The FIO effect to run.</param> | ||
| <returns>A fiber representing the running effect.</returns> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.FRuntime"> | ||
| <summary> | ||
| Represents a functional runtime for interpreting FIO effects. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Direct.Runtime"> | ||
| <summary> | ||
| Represents the direct runtime for FIO, interpreting effects on the current thread. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Direct"> | ||
| <summary> | ||
| Provides the direct runtime for interpreting FIO effects, executing effects on the current thread. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Cooperative.Runtime"> | ||
| <summary> | ||
| Represents the cooperative runtime for FIO, interpreting effects concurrently using work-stealing and multiple workers. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Cooperative"> | ||
| <summary> | ||
| Provides the cooperative (work-stealing) runtime for interpreting FIO effects, enabling concurrent and asynchronous execution across multiple workers. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Concurrent.Runtime"> | ||
| <summary> | ||
| Represents the concurrent runtime for FIO, interpreting effects using event-driven concurrency and advanced scheduling. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.FIO.Runtime.Concurrent"> | ||
| <summary> | ||
| Provides the concurrent (advanced, event-driven) runtime for interpreting FIO effects, enabling scalable and highly concurrent execution. | ||
| </summary> | ||
| </member> | ||
| </members> | ||
| </doc> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No alert changes
No metric changes