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

package/src/StreamEmit.ts

@@ -0,0 +1,136 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Cause from "./Cause.js"
+import type * as Chunk from "./Chunk.js"
+import type * as Effect from "./Effect.js"
+import type * as Exit from "./Exit.js"
+import type * as Option from "./Option.js"
+
+/**
+ * An `Emit<R, E, A, B>` represents an asynchronous callback that can be
+ * called multiple times. The callback can be called with a value of type
+ * `Effect<Chunk<A>, Option<E>, R>`, where succeeding with a `Chunk<A>`
+ * indicates to emit those elements, failing with `Some<E>` indicates to
+ * terminate with that error, and failing with `None` indicates to terminate
+ * with an end of stream signal.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export interface Emit<in R, in E, in A, out B> extends EmitOps<R, E, A, B> {
+  (f: Effect.Effect<Chunk.Chunk<A>, Option.Option<E>, R>): Promise<B>
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface EmitOps<in R, in E, in A, out B> {
+  /**
+   * Emits a chunk containing the specified values.
+   */
+  chunk(chunk: Chunk.Chunk<A>): Promise<B>
+
+  /**
+   * Terminates with a cause that dies with the specified defect.
+   */
+  die<Err>(defect: Err): Promise<B>
+
+  /**
+   * Terminates with a cause that dies with a `Throwable` with the specified
+   * message.
+   */
+  dieMessage(message: string): Promise<B>
+
+  /**
+   * Either emits the specified value if this `Exit` is a `Success` or else
+   * terminates with the specified cause if this `Exit` is a `Failure`.
+   */
+  done(exit: Exit.Exit<A, E>): Promise<B>
+
+  /**
+   * Terminates with an end of stream signal.
+   */
+  end(): Promise<B>
+
+  /**
+   * Terminates with the specified error.
+   */
+  fail(error: E): Promise<B>
+
+  /**
+   * Either emits the success value of this effect or terminates the stream
+   * with the failure value of this effect.
+   */
+  fromEffect(effect: Effect.Effect<A, E, R>): Promise<B>
+
+  /**
+   * Either emits the success value of this effect or terminates the stream
+   * with the failure value of this effect.
+   */
+  fromEffectChunk(effect: Effect.Effect<Chunk.Chunk<A>, E, R>): Promise<B>
+
+  /**
+   * Terminates the stream with the specified cause.
+   */
+  halt(cause: Cause.Cause<E>): Promise<B>
+
+  /**
+   * Emits a chunk containing the specified value.
+   */
+  single(value: A): Promise<B>
+}
+
+/**
+ * @since 3.6.0
+ * @category models
+ */
+export interface EmitOpsPush<in E, in A> {
+  /**
+   * Emits a chunk containing the specified values.
+   */
+  chunk(chunk: Chunk.Chunk<A>): boolean
+
+  /**
+   * Emits a chunk containing the specified values.
+   */
+  array(chunk: ReadonlyArray<A>): boolean
+
+  /**
+   * Terminates with a cause that dies with the specified defect.
+   */
+  die<Err>(defect: Err): void
+
+  /**
+   * Terminates with a cause that dies with a `Throwable` with the specified
+   * message.
+   */
+  dieMessage(message: string): void
+
+  /**
+   * Either emits the specified value if this `Exit` is a `Success` or else
+   * terminates with the specified cause if this `Exit` is a `Failure`.
+   */
+  done(exit: Exit.Exit<A, E>): void
+
+  /**
+   * Terminates with an end of stream signal.
+   */
+  end(): void
+
+  /**
+   * Terminates with the specified error.
+   */
+  fail(error: E): void
+
+  /**
+   * Terminates the stream with the specified cause.
+   */
+  halt(cause: Cause.Cause<E>): void
+
+  /**
+   * Emits a chunk containing the specified value.
+   */
+  single(value: A): boolean
+}

package/src/StreamHaltStrategy.ts

@@ -0,0 +1,123 @@
+/**
+ * @since 2.0.0
+ */
+import * as internal from "./internal/stream/haltStrategy.js"
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export type HaltStrategy = Left | Right | Both | Either
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export type HaltStrategyInput = HaltStrategy | "left" | "right" | "both" | "either"
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Left {
+  readonly _tag: "Left"
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Right {
+  readonly _tag: "Right"
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Both {
+  readonly _tag: "Both"
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Either {
+  readonly _tag: "Either"
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const Left: HaltStrategy = internal.Left
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const Right: HaltStrategy = internal.Right
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const Both: HaltStrategy = internal.Both
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const Either: HaltStrategy = internal.Either
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const fromInput: (input: HaltStrategyInput) => HaltStrategy = internal.fromInput
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isLeft: (self: HaltStrategy) => self is Left = internal.isLeft
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isRight: (self: HaltStrategy) => self is Right = internal.isRight
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isBoth: (self: HaltStrategy) => self is Both = internal.isBoth
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isEither: (self: HaltStrategy) => self is Either = internal.isEither
+
+/**
+ * Folds over the specified `HaltStrategy` using the provided case functions.
+ *
+ * @since 2.0.0
+ * @category folding
+ */
+export const match: {
+  <Z>(options: {
+    readonly onLeft: () => Z
+    readonly onRight: () => Z
+    readonly onBoth: () => Z
+    readonly onEither: () => Z
+  }): (self: HaltStrategy) => Z
+  <Z>(self: HaltStrategy, options: {
+    readonly onLeft: () => Z
+    readonly onRight: () => Z
+    readonly onBoth: () => Z
+    readonly onEither: () => Z
+  }): Z
+} = internal.match

package/src/Streamable.ts

@@ -0,0 +1,45 @@
+/**
+ * @since 2.0.0
+ */
+
+import { pipeArguments } from "./Pipeable.js"
+import * as Stream from "./Stream.js"
+
+const streamVariance = {
+  /* c8 ignore next */
+  _R: (_: never) => _,
+  /* c8 ignore next */
+  _E: (_: never) => _,
+  /* c8 ignore next */
+  _A: (_: never) => _
+}
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export abstract class Class<A, E = never, R = never> implements Stream.Stream<A, E, R> {
+  /**
+   * @since 2.0.0
+   */
+  readonly [Stream.StreamTypeId] = streamVariance
+
+  /**
+   * @since 2.0.0
+   */
+  pipe() {
+    return pipeArguments(this, arguments)
+  }
+
+  /**
+   * @since 2.0.0
+   */
+  abstract toStream(): Stream.Stream<A, E, R>
+
+  /**
+   * @internal
+   */
+  get channel() {
+    return Stream.toChannel(this.toStream())
+  }
+}