effect 2.0.0-next.44 → 2.0.0-next.46

package/src/FiberRefs.ts

@@ -0,0 +1,160 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Effect from "./Effect"
+import type * as FiberId from "./FiberId"
+import type * as FiberRef from "./FiberRef"
+import type * as HashSet from "./HashSet"
+import * as internal from "./internal/fiberRefs"
+import type * as Option from "./Option"
+import type { Pipeable } from "./Pipeable"
+import type * as Arr from "./ReadonlyArray"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const FiberRefsSym: unique symbol = internal.FiberRefsSym
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type FiberRefsSym = typeof FiberRefsSym
+
+/**
+ * `FiberRefs` is a data type that represents a collection of `FiberRef` values.
+ *
+ * This allows safely propagating `FiberRef` values across fiber boundaries, for
+ * example between an asynchronous producer and consumer.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export interface FiberRefs extends Pipeable {
+  readonly [FiberRefsSym]: FiberRefsSym
+  readonly locals: Map<FiberRef.FiberRef<any>, Arr.NonEmptyReadonlyArray<readonly [FiberId.Runtime, any]>>
+}
+
+const delete_: {
+  <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => FiberRefs
+  <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): FiberRefs
+} = internal.delete_
+
+export {
+  /**
+   * Deletes the specified `FiberRef` from the `FibterRefs`.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
+  delete_ as delete
+}
+
+/**
+ * Returns a set of each `FiberRef` in this collection.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const fiberRefs: (self: FiberRefs) => HashSet.HashSet<FiberRef.FiberRef<any>> = internal.fiberRefs
+
+/**
+ * Forks this collection of fiber refs as the specified child fiber id. This
+ * will potentially modify the value of the fiber refs, as determined by the
+ * individual fiber refs that make up the collection.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const forkAs: {
+  (childId: FiberId.Runtime): (self: FiberRefs) => FiberRefs
+  (self: FiberRefs, childId: FiberId.Runtime): FiberRefs
+} = internal.forkAs
+
+/**
+ * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+ * values if it exists or `None` otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const get: {
+  <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => Option.Option<A>
+  <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): Option.Option<A>
+} = internal.get
+
+/**
+ * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+ * values if it exists or the `initial` value of the `FiberRef` otherwise.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const getOrDefault: {
+  <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => A
+  <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): A
+} = internal.getOrDefault
+
+/**
+ * Joins this collection of fiber refs to the specified collection, as the
+ * specified fiber id. This will perform diffing and merging to ensure
+ * preservation of maximum information from both child and parent refs.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const joinAs: {
+  (fiberId: FiberId.Runtime, that: FiberRefs): (self: FiberRefs) => FiberRefs
+  (self: FiberRefs, fiberId: FiberId.Runtime, that: FiberRefs): FiberRefs
+} = internal.joinAs
+
+/**
+ * Set each ref to either its value or its default.
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const setAll: (self: FiberRefs) => Effect.Effect<never, never, void> = internal.setAll
+
+/**
+ * Updates the value of the specified `FiberRef` using the provided `FiberId`
+ *
+ * @since 2.0.0
+ * @category utils
+ */
+export const updatedAs: {
+  <A>(
+    options: {
+      readonly fiberId: FiberId.Runtime
+      readonly fiberRef: FiberRef.FiberRef<A>
+      readonly value: A
+    }
+  ): (self: FiberRefs) => FiberRefs
+  <A>(
+    self: FiberRefs,
+    options: {
+      readonly fiberId: FiberId.Runtime
+      readonly fiberRef: FiberRef.FiberRef<A>
+      readonly value: A
+    }
+  ): FiberRefs
+} = internal.updatedAs
+
+/**
+ * Note: it will not copy the provided Map, make sure to provide a fresh one.
+ *
+ * @since 2.0.0
+ * @category unsafe
+ */
+export const unsafeMake: (
+  fiberRefLocals: Map<FiberRef.FiberRef<any>, Arr.NonEmptyReadonlyArray<readonly [FiberId.Runtime, any]>>
+) => FiberRefs = internal.unsafeMake
+
+/**
+ * The empty collection of `FiberRef` values.
+ *
+ * @category constructors
+ * @since 2.0.0
+ */
+export const empty: () => FiberRefs = internal.empty

package/src/FiberRefsPatch.ts

@@ -0,0 +1,105 @@
+/**
+ * @since 2.0.0
+ */
+import type * as FiberId from "./FiberId"
+import type * as FiberRef from "./FiberRef"
+import type * as FiberRefs from "./FiberRefs"
+import * as internal from "./internal/fiberRefs/patch"
+
+/**
+ * A `FiberRefsPatch` captures the changes in `FiberRef` values made by a single
+ * fiber as a value. This allows fibers to apply the changes made by a workflow
+ * without inheriting all the `FiberRef` values of the fiber that executed the
+ * workflow.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export type FiberRefsPatch = Empty | Add | Remove | Update | AndThen
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Empty {
+  readonly _tag: "Empty"
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Add {
+  readonly _tag: "Add"
+  readonly fiberRef: FiberRef.FiberRef<unknown>
+  readonly value: unknown
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Remove {
+  readonly _tag: "Remove"
+  readonly fiberRef: FiberRef.FiberRef<unknown>
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Update {
+  readonly _tag: "Update"
+  readonly fiberRef: FiberRef.FiberRef<unknown>
+  readonly patch: unknown
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface AndThen {
+  readonly _tag: "AndThen"
+  readonly first: FiberRefsPatch
+  readonly second: FiberRefsPatch
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const empty: FiberRefsPatch = internal.empty
+
+/**
+ * Constructs a patch that describes the changes between the specified
+ * collections of `FiberRef`
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const diff: (oldValue: FiberRefs.FiberRefs, newValue: FiberRefs.FiberRefs) => FiberRefsPatch = internal.diff
+
+/**
+ * Combines this patch and the specified patch to create a new patch that
+ * describes applying the changes from this patch and the specified patch
+ * sequentially.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const combine: {
+  (that: FiberRefsPatch): (self: FiberRefsPatch) => FiberRefsPatch
+  (self: FiberRefsPatch, that: FiberRefsPatch): FiberRefsPatch
+} = internal.combine
+
+/**
+ * Applies the changes described by this patch to the specified collection
+ * of `FiberRef` values.
+ *
+ * @since 2.0.0
+ * @category destructors
+ */
+export const patch: {
+  (fiberId: FiberId.Runtime, oldValue: FiberRefs.FiberRefs): (self: FiberRefsPatch) => FiberRefs.FiberRefs
+  (self: FiberRefsPatch, fiberId: FiberId.Runtime, oldValue: FiberRefs.FiberRefs): FiberRefs.FiberRefs
+} = internal.patch

package/src/FiberStatus.ts

@@ -0,0 +1,108 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Equal from "./Equal"
+import type * as FiberId from "./FiberId"
+import * as internal from "./internal/fiberStatus"
+import type * as RuntimeFlags from "./RuntimeFlags"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const FiberStatusTypeId: unique symbol = internal.FiberStatusTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type FiberStatusTypeId = typeof FiberStatusTypeId
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export type FiberStatus = Done | Running | Suspended
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Done extends Equal.Equal {
+  readonly _tag: "Done"
+  readonly [FiberStatusTypeId]: FiberStatusTypeId
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Running extends Equal.Equal {
+  readonly _tag: "Running"
+  readonly [FiberStatusTypeId]: FiberStatusTypeId
+  readonly runtimeFlags: RuntimeFlags.RuntimeFlags
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Suspended extends Equal.Equal {
+  readonly _tag: "Suspended"
+  readonly [FiberStatusTypeId]: FiberStatusTypeId
+  readonly runtimeFlags: RuntimeFlags.RuntimeFlags
+  readonly blockingOn: FiberId.FiberId
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const done: FiberStatus = internal.done
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const running: (runtimeFlags: RuntimeFlags.RuntimeFlags) => FiberStatus = internal.running
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const suspended: (runtimeFlags: RuntimeFlags.RuntimeFlags, blockingOn: FiberId.FiberId) => FiberStatus =
+  internal.suspended
+
+/**
+ * Returns `true` if the specified value is a `FiberStatus`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isFiberStatus: (u: unknown) => u is FiberStatus = internal.isFiberStatus
+
+/**
+ * Returns `true` if the specified `FiberStatus` is `Done`, `false` otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isDone: (self: FiberStatus) => self is Done = internal.isDone
+
+/**
+ * Returns `true` if the specified `FiberStatus` is `Running`, `false`
+ * otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isRunning: (self: FiberStatus) => self is Running = internal.isRunning
+
+/**
+ * Returns `true` if the specified `FiberStatus` is `Suspended`, `false`
+ * otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isSuspended: (self: FiberStatus) => self is Suspended = internal.isSuspended