/** * @since 3.5.0 */ import type * as Cause from "./Cause.js"; import type * as Duration from "./Duration.js"; import type * as Effect from "./Effect.js"; import { type Pipeable } from "./Pipeable.js"; import type * as Scope from "./Scope.js"; import type * as Types from "./Types.js"; /** * @since 3.5.0 * @category type ids */ export declare const TypeId: unique symbol; /** * @since 3.5.0 * @category type ids */ export type TypeId = typeof TypeId; /** * @since 3.5.0 * @category models */ export interface RcMap extends Pipeable { readonly [TypeId]: RcMap.Variance; } /** * @since 3.5.0 * @category models */ export declare namespace RcMap { /** * @since 3.5.0 * @category models */ interface Variance { readonly _K: Types.Contravariant; readonly _A: Types.Covariant; readonly _E: Types.Covariant; } } /** * An `RcMap` can contain multiple reference counted resources that can be indexed * by a key. The resources are lazily acquired on the first call to `get` and * released when the last reference is released. * * Complex keys can extend `Equal` and `Hash` to allow lookups by value. * * **Options** * * - `capacity`: The maximum number of resources that can be held in the map. * - `idleTimeToLive`: When the reference count reaches zero, the resource will be released after this duration. * * @since 3.5.0 * @category models * @example * ```ts * import { Effect, RcMap } from "effect" * * Effect.gen(function*() { * const map = yield* RcMap.make({ * lookup: (key: string) => * Effect.acquireRelease( * Effect.succeed(`acquired ${key}`), * () => Effect.log(`releasing ${key}`) * ) * }) * * // Get "foo" from the map twice, which will only acquire it once. * // It will then be released once the scope closes. * yield* RcMap.get(map, "foo").pipe( * Effect.andThen(RcMap.get(map, "foo")), * Effect.scoped * ) * }) * ``` */ export declare const make: { /** * An `RcMap` can contain multiple reference counted resources that can be indexed * by a key. The resources are lazily acquired on the first call to `get` and * released when the last reference is released. * * Complex keys can extend `Equal` and `Hash` to allow lookups by value. * * **Options** * * - `capacity`: The maximum number of resources that can be held in the map. * - `idleTimeToLive`: When the reference count reaches zero, the resource will be released after this duration. * * @since 3.5.0 * @category models * @example * ```ts * import { Effect, RcMap } from "effect" * * Effect.gen(function*() { * const map = yield* RcMap.make({ * lookup: (key: string) => * Effect.acquireRelease( * Effect.succeed(`acquired ${key}`), * () => Effect.log(`releasing ${key}`) * ) * }) * * // Get "foo" from the map twice, which will only acquire it once. * // It will then be released once the scope closes. * yield* RcMap.get(map, "foo").pipe( * Effect.andThen(RcMap.get(map, "foo")), * Effect.scoped * ) * }) * ``` */ (options: { readonly lookup: (key: K) => Effect.Effect; readonly idleTimeToLive?: Duration.DurationInput | undefined; readonly capacity?: undefined; }): Effect.Effect, never, Scope.Scope | R>; /** * An `RcMap` can contain multiple reference counted resources that can be indexed * by a key. The resources are lazily acquired on the first call to `get` and * released when the last reference is released. * * Complex keys can extend `Equal` and `Hash` to allow lookups by value. * * **Options** * * - `capacity`: The maximum number of resources that can be held in the map. * - `idleTimeToLive`: When the reference count reaches zero, the resource will be released after this duration. * * @since 3.5.0 * @category models * @example * ```ts * import { Effect, RcMap } from "effect" * * Effect.gen(function*() { * const map = yield* RcMap.make({ * lookup: (key: string) => * Effect.acquireRelease( * Effect.succeed(`acquired ${key}`), * () => Effect.log(`releasing ${key}`) * ) * }) * * // Get "foo" from the map twice, which will only acquire it once. * // It will then be released once the scope closes. * yield* RcMap.get(map, "foo").pipe( * Effect.andThen(RcMap.get(map, "foo")), * Effect.scoped * ) * }) * ``` */ (options: { readonly lookup: (key: K) => Effect.Effect; readonly idleTimeToLive?: Duration.DurationInput | undefined; readonly capacity: number; }): Effect.Effect, never, Scope.Scope | R>; }; /** * @since 3.5.0 * @category combinators */ export declare const get: { /** * @since 3.5.0 * @category combinators */ (key: K): (self: RcMap) => Effect.Effect; /** * @since 3.5.0 * @category combinators */ (self: RcMap, key: K): Effect.Effect; }; /** * @since 3.8.0 * @category combinators */ export declare const keys: (self: RcMap) => Effect.Effect, E>; /** * @since 3.13.0 * @category combinators */ export declare const invalidate: { /** * @since 3.13.0 * @category combinators */ (key: K): (self: RcMap) => Effect.Effect; /** * @since 3.13.0 * @category combinators */ (self: RcMap, key: K): Effect.Effect; }; /** * @since 3.13.0 * @category combinators */ export declare const touch: { /** * @since 3.13.0 * @category combinators */ (key: K): (self: RcMap) => Effect.Effect; /** * @since 3.13.0 * @category combinators */ (self: RcMap, key: K): Effect.Effect; }; //# sourceMappingURL=RcMap.d.ts.map