@clayroach/effect 3.19.14-source-capture.8 → 3.19.14-source-trace.1

package/src/TSet.ts

@@ -0,0 +1,365 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Chunk from "./Chunk.js"
+import type * as HashSet from "./HashSet.js"
+import * as internal from "./internal/stm/tSet.js"
+import type * as Option from "./Option.js"
+import type { Predicate } from "./Predicate.js"
+import type * as STM from "./STM.js"
+import type * as TMap from "./TMap.js"
+import type * as Types from "./Types.js"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const TSetTypeId: unique symbol = internal.TSetTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type TSetTypeId = typeof TSetTypeId
+
+/**
+ * Transactional set implemented on top of `TMap`.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export interface TSet<in out A> extends TSet.Variance<A> {}
+/**
+ * @internal
+ * @since 2.0.0
+ */
+export interface TSet<in out A> {
+  /** @internal */
+  readonly tMap: TMap.TMap<A, void>
+}
+
+/**
+ * @since 2.0.0
+ */
+export declare namespace TSet {
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export interface Variance<in out A> {
+    readonly [TSetTypeId]: {
+      readonly _A: Types.Invariant<A>
+    }
+  }
+}
+
+/**
+ * Stores new element in the set.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const add: {
+  <A>(value: A): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, value: A): STM.STM<void>
+} = internal.add
+
+/**
+ * Atomically transforms the set into the difference of itself and the
+ * provided set.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const difference: {
+  <A>(other: TSet<A>): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, other: TSet<A>): STM.STM<void>
+} = internal.difference
+
+/**
+ * Makes an empty `TSet`.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const empty: <A>() => STM.STM<TSet<A>> = internal.empty
+
+/**
+ * Atomically performs transactional-effect for each element in set.
+ *
+ * @since 2.0.0
+ * @category elements
+ */
+export const forEach: {
+  <A, R, E>(f: (value: A) => STM.STM<void, E, R>): (self: TSet<A>) => STM.STM<void, E, R>
+  <A, R, E>(self: TSet<A>, f: (value: A) => STM.STM<void, E, R>): STM.STM<void, E, R>
+} = internal.forEach
+
+/**
+ * Creates a new `TSet` from an iterable collection of values.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const fromIterable: <A>(iterable: Iterable<A>) => STM.STM<TSet<A>> = internal.fromIterable
+
+/**
+ * Tests whether or not set contains an element.
+ *
+ * @since 2.0.0
+ * @category elements
+ */
+export const has: {
+  <A>(value: A): (self: TSet<A>) => STM.STM<boolean>
+  <A>(self: TSet<A>, value: A): STM.STM<boolean>
+} = internal.has
+
+/**
+ * Atomically transforms the set into the intersection of itself and the
+ * provided set.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const intersection: {
+  <A>(other: TSet<A>): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, other: TSet<A>): STM.STM<void>
+} = internal.intersection
+
+/**
+ * Tests if the set is empty or not
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const isEmpty: <A>(self: TSet<A>) => STM.STM<boolean> = internal.isEmpty
+
+/**
+ * Makes a new `TSet` that is initialized with specified values.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+export const make: <Elements extends Array<any>>(
+  ...elements: Elements
+) => STM.STM<TSet<Elements[number]>> = internal.make
+
+/**
+ * Atomically folds using a pure function.
+ *
+ * @since 2.0.0
+ * @category folding
+ */
+export const reduce: {
+  <Z, A>(zero: Z, f: (accumulator: Z, value: A) => Z): (self: TSet<A>) => STM.STM<Z>
+  <Z, A>(self: TSet<A>, zero: Z, f: (accumulator: Z, value: A) => Z): STM.STM<Z>
+} = internal.reduce
+
+/**
+ * Atomically folds using a transactional function.
+ *
+ * @since 2.0.0
+ * @category folding
+ */
+export const reduceSTM: {
+  <Z, A, R, E>(zero: Z, f: (accumulator: Z, value: A) => STM.STM<Z, E, R>): (self: TSet<A>) => STM.STM<Z, E, R>
+  <Z, A, R, E>(self: TSet<A>, zero: Z, f: (accumulator: Z, value: A) => STM.STM<Z, E, R>): STM.STM<Z, E, R>
+} = internal.reduceSTM
+
+/**
+ * Removes a single element from the set.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const remove: {
+  <A>(value: A): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, value: A): STM.STM<void>
+} = internal.remove
+
+/**
+ * Removes elements from the set.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const removeAll: {
+  <A>(iterable: Iterable<A>): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, iterable: Iterable<A>): STM.STM<void>
+} = internal.removeAll
+
+/**
+ * Removes entries from a `TSet` that satisfy the specified predicate and returns the removed entries
+ * (or `void` if `discard = true`).
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const removeIf: {
+  <A>(predicate: Predicate<A>, options: {
+    readonly discard: true
+  }): (self: TSet<A>) => STM.STM<void>
+  <A>(
+    predicate: Predicate<A>,
+    options?: {
+      readonly discard: false
+    }
+  ): (self: TSet<A>) => STM.STM<Array<A>>
+  <A>(self: TSet<A>, predicate: Predicate<A>, options: {
+    readonly discard: true
+  }): STM.STM<void>
+  <A>(
+    self: TSet<A>,
+    predicate: Predicate<A>,
+    options?: {
+      readonly discard: false
+    }
+  ): STM.STM<Array<A>>
+} = internal.removeIf
+
+/**
+ * Retains entries in a `TSet` that satisfy the specified predicate and returns the removed entries
+ * (or `void` if `discard = true`).
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const retainIf: {
+  <A>(predicate: Predicate<A>, options: {
+    readonly discard: true
+  }): (self: TSet<A>) => STM.STM<void>
+  <A>(
+    predicate: Predicate<A>,
+    options?: {
+      readonly discard: false
+    }
+  ): (self: TSet<A>) => STM.STM<Array<A>>
+  <A>(self: TSet<A>, predicate: Predicate<A>, options: {
+    readonly discard: true
+  }): STM.STM<void>
+  <A>(
+    self: TSet<A>,
+    predicate: Predicate<A>,
+    options?: {
+      readonly discard: false
+    }
+  ): STM.STM<Array<A>>
+} = internal.retainIf
+
+/**
+ * Returns the set's cardinality.
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+export const size: <A>(self: TSet<A>) => STM.STM<number> = internal.size
+
+/**
+ * Takes the first matching value, or retries until there is one.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const takeFirst: {
+  <A, B>(pf: (a: A) => Option.Option<B>): (self: TSet<A>) => STM.STM<B>
+  <A, B>(self: TSet<A>, pf: (a: A) => Option.Option<B>): STM.STM<B>
+} = internal.takeFirst
+
+/**
+ * Takes the first matching value, or retries until there is one.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const takeFirstSTM: {
+  <A, B, E, R>(pf: (a: A) => STM.STM<B, Option.Option<E>, R>): (self: TSet<A>) => STM.STM<B, E, R>
+  <A, B, E, R>(self: TSet<A>, pf: (a: A) => STM.STM<B, Option.Option<E>, R>): STM.STM<B, E, R>
+} = internal.takeFirstSTM
+
+/**
+ * Takes all matching values, or retries until there is at least one.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const takeSome: {
+  <A, B>(pf: (a: A) => Option.Option<B>): (self: TSet<A>) => STM.STM<[B, ...Array<B>]>
+  <A, B>(self: TSet<A>, pf: (a: A) => Option.Option<B>): STM.STM<[B, ...Array<B>]>
+} = internal.takeSome
+
+/**
+ * Takes all matching values, or retries until there is at least one.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const takeSomeSTM: {
+  <A, B, E, R>(pf: (a: A) => STM.STM<B, Option.Option<E>, R>): (self: TSet<A>) => STM.STM<[B, ...Array<B>], E, R>
+  <A, B, E, R>(self: TSet<A>, pf: (a: A) => STM.STM<B, Option.Option<E>, R>): STM.STM<[B, ...Array<B>], E, R>
+} = internal.takeSomeSTM
+
+/**
+ * Collects all elements into a `Chunk`.
+ *
+ * @since 2.0.0
+ * @category destructors
+ */
+export const toChunk: <A>(self: TSet<A>) => STM.STM<Chunk.Chunk<A>> = internal.toChunk
+
+/**
+ * Collects all elements into a `HashSet`.
+ *
+ * @since 2.0.0
+ * @category destructors
+ */
+export const toHashSet: <A>(self: TSet<A>) => STM.STM<HashSet.HashSet<A>> = internal.toHashSet
+
+/**
+ * Collects all elements into a `Array`.
+ *
+ * @since 2.0.0
+ * @category destructors
+ */
+export const toArray: <A>(self: TSet<A>) => STM.STM<Array<A>> = internal.toArray
+
+/**
+ * Collects all elements into a `ReadonlySet`.
+ *
+ * @since 2.0.0
+ * @category destructors
+ */
+export const toReadonlySet: <A>(self: TSet<A>) => STM.STM<ReadonlySet<A>> = internal.toReadonlySet
+
+/**
+ * Atomically updates all elements using a pure function.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const transform: {
+  <A>(f: (a: A) => A): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, f: (a: A) => A): STM.STM<void>
+} = internal.transform
+
+/**
+ * Atomically updates all elements using a transactional function.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const transformSTM: {
+  <A, R, E>(f: (a: A) => STM.STM<A, E, R>): (self: TSet<A>) => STM.STM<void, E, R>
+  <A, R, E>(self: TSet<A>, f: (a: A) => STM.STM<A, E, R>): STM.STM<void, E, R>
+} = internal.transformSTM
+
+/**
+ * Atomically transforms the set into the union of itself and the provided
+ * set.
+ *
+ * @since 2.0.0
+ * @category mutations
+ */
+export const union: {
+  <A>(other: TSet<A>): (self: TSet<A>) => STM.STM<void>
+  <A>(self: TSet<A>, other: TSet<A>): STM.STM<void>
+} = internal.union

package/src/TSubscriptionRef.ts

@@ -0,0 +1,192 @@
+/**
+ * @since 3.10.0
+ */
+import type * as Effect from "./Effect.js"
+import * as internal from "./internal/stm/tSubscriptionRef.js"
+import type * as Option from "./Option.js"
+import type * as Scope from "./Scope.js"
+import type * as STM from "./STM.js"
+import type * as Stream from "./Stream.js"
+import type * as TPubSub from "./TPubSub.js"
+import type * as TQueue from "./TQueue.js"
+import type * as TRef from "./TRef.js"
+import type * as Types from "./Types.js"
+
+/**
+ * @since 3.10.0
+ * @category symbols
+ */
+export const TSubscriptionRefTypeId: unique symbol = internal.TSubscriptionRefTypeId
+
+/**
+ * @since 3.10.0
+ * @category symbols
+ */
+export type TSubscriptionRefTypeId = typeof TSubscriptionRefTypeId
+
+/**
+ * A `TSubscriptionRef<A>` is a `TRef` that can be subscribed to in order to
+ * receive a `TDequeue<A>` of the current value and all committed changes to the value.
+ *
+ * @since 3.10.0
+ * @category models
+ */
+export interface TSubscriptionRef<in out A> extends TSubscriptionRef.Variance<A>, TRef.TRef<A> {
+  /** @internal */
+  readonly ref: TRef.TRef<A>
+  /** @internal */
+  readonly pubsub: TPubSub.TPubSub<A>
+  /** @internal */
+  modify<B>(f: (a: A) => readonly [B, A]): STM.STM<B>
+
+  /**
+   * A TDequeue containing the current value of the `Ref` as well as all changes
+   * to that value.
+   */
+  readonly changes: STM.STM<TQueue.TDequeue<A>>
+}
+
+/**
+ * @since 3.10.0
+ */
+export declare namespace TSubscriptionRef {
+  /**
+   * @since 3.10.0
+   * @category models
+   */
+  export interface Variance<in out A> {
+    readonly [TSubscriptionRefTypeId]: {
+      readonly _A: Types.Invariant<A>
+    }
+  }
+}
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const get: <A>(self: TSubscriptionRef<A>) => STM.STM<A> = internal.get
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const getAndSet: {
+  <A>(value: A): (self: TSubscriptionRef<A>) => STM.STM<A>
+  <A>(self: TSubscriptionRef<A>, value: A): STM.STM<A>
+} = internal.getAndSet
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const getAndUpdate: {
+  <A>(f: (a: A) => A): (self: TSubscriptionRef<A>) => STM.STM<A>
+  <A>(self: TSubscriptionRef<A>, f: (a: A) => A): STM.STM<A>
+} = internal.getAndUpdate
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const getAndUpdateSome: {
+  <A>(f: (a: A) => Option.Option<A>): (self: TSubscriptionRef<A>) => STM.STM<A>
+  <A>(self: TSubscriptionRef<A>, f: (a: A) => Option.Option<A>): STM.STM<A>
+} = internal.getAndUpdateSome
+
+/**
+ * @since 3.10.0
+ * @category constructors
+ */
+export const make: <A>(value: A) => STM.STM<TSubscriptionRef<A>> = internal.make
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const modify: {
+  <A, B>(f: (a: A) => readonly [B, A]): (self: TSubscriptionRef<A>) => STM.STM<B>
+  <A, B>(self: TSubscriptionRef<A>, f: (a: A) => readonly [B, A]): STM.STM<B>
+} = internal.modify
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const modifySome: {
+  <A, B>(fallback: B, f: (a: A) => Option.Option<readonly [B, A]>): (self: TSubscriptionRef<A>) => STM.STM<B>
+  <A, B>(self: TSubscriptionRef<A>, fallback: B, f: (a: A) => Option.Option<readonly [B, A]>): STM.STM<B>
+} = internal.modifySome
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const set: {
+  <A>(value: A): (self: TSubscriptionRef<A>) => STM.STM<void>
+  <A>(self: TSubscriptionRef<A>, value: A): STM.STM<void>
+} = internal.set
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const setAndGet: {
+  <A>(value: A): (self: TSubscriptionRef<A>) => STM.STM<A>
+  <A>(self: TSubscriptionRef<A>, value: A): STM.STM<A>
+} = internal.setAndGet
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const update: {
+  <A>(f: (a: A) => A): (self: TSubscriptionRef<A>) => STM.STM<void>
+  <A>(self: TSubscriptionRef<A>, f: (a: A) => A): STM.STM<void>
+} = internal.update
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const updateAndGet: {
+  <A>(f: (a: A) => A): (self: TSubscriptionRef<A>) => STM.STM<A>
+  <A>(self: TSubscriptionRef<A>, f: (a: A) => A): STM.STM<A>
+} = internal.updateAndGet
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const updateSome: {
+  <A>(f: (a: A) => Option.Option<A>): (self: TSubscriptionRef<A>) => STM.STM<void>
+  <A>(self: TSubscriptionRef<A>, f: (a: A) => Option.Option<A>): STM.STM<void>
+} = internal.updateSome
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const updateSomeAndGet: {
+  <A>(f: (a: A) => Option.Option<A>): (self: TSubscriptionRef<A>) => STM.STM<A>
+  <A>(self: TSubscriptionRef<A>, f: (a: A) => Option.Option<A>): STM.STM<A>
+} = internal.updateSomeAndGet
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const changesScoped: <A>(self: TSubscriptionRef<A>) => Effect.Effect<TQueue.TDequeue<A>, never, Scope.Scope> =
+  internal.changesScoped
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const changesStream: <A>(self: TSubscriptionRef<A>) => Stream.Stream<A> = internal.changesStream
+
+/**
+ * @since 3.10.0
+ * @category mutations
+ */
+export const changes: <A>(self: TSubscriptionRef<A>) => STM.STM<TQueue.TDequeue<A>> = (self) => self.changes