Skip to content

Commit 99ffcaa

Browse files
committed
Rename runtime context docs to host context
1 parent e64c106 commit 99ffcaa

296 files changed

Lines changed: 7779 additions & 7778 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/managing-dependencies/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ the others.
3333
| :--- | :--- | :--- | :--- | :--- |
3434
| 1 | Environment + record | One record gives you an explicit boundary, direct field access, and easy construction | **[AppRecord](../../tutorials/app-record/)** | `Flow.env`, `Flow.read`, `Flow.localEnv` |
3535
| 2 | [Nominal capability contracts](./capability-contracts/) | An interface through a capability contract puts the dependency surface in the type, so the compiler checks it and helpers advertise it | **[Capabilities](../../tutorials/capabilities/)** | interfaces, `Flow.read` |
36-
| 3 | [HostContext<'host, 'appEnv>](./runtime-context/) | Two readers separate the host from app services, so each side stays named and explicit | **[HostContext](../../tutorials/runtime-context/)** | `HostContext.create`, `Flow.readHost`, `Flow.readAppEnv` |
36+
| 3 | [HostContext<'host, 'appEnv>](./host-context/) | Two readers separate the host from app services, so each side stays named and explicit | **[HostContext](../../tutorials/host-context/)** | `HostContext.create`, `Flow.readHost`, `Flow.readAppEnv` |
3737
| 4 | [Standard .NET AppHost Plus DI](./provider-edge/) | Host registrations become a boundary record or nominal contract once, and workflow code stays on typed values | **[AppHost](../../tutorials/app-host/)** | `Resolver.fromProvider`, `MissingCapability` |
3838

3939
## Start With A Record

docs/managing-dependencies/runtime-context.md renamed to docs/managing-dependencies/host-context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,6 @@ to read them through `Flow.readHost` and `Flow.readAppEnv`.
106106
Keep the adapter layer at the boundary that creates the `HostContext`; do not thread it through
107107
every helper just because it is available.
108108

109-
See the [HostContext reference](../../reference/runtime/) for the constructors and mapping
109+
See the [HostContext reference](../../reference/host/) for the constructors and mapping
110110
helpers, and the [Capability reference](../../reference/capability/) for the `host`,
111111
`appEnv`, and `resolve` readers.

docs/reference/capability/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ In FsFlow, a capability is a named interface that describes what a flow needs fr
1414

1515
- [`MissingCapability`](./t-missingcapability.md): Describes a missing service-provider capability.
1616
- [`Resolver.resolve`](./m-resolver-resolve.md): Reads a dependency from the environment using the provided projection.
17-
- [`Resolver.runtime`](./m-resolver-runtime.md): Reads the current runtime from the environment.
18-
- [`Resolver.environment`](./m-resolver-environment.md): Reads the application environment from the environment.
17+
- [`Resolver.host`](./m-resolver-host.md): Reads the current host from the environment.
18+
- [`Resolver.appEnv`](./m-resolver-appenv.md): Reads the application environment from the environment.
1919
- [`Resolver.fromProvider`](./m-resolver-fromprovider.md): Reads a dependency from <a href="https://learn.microsoft.com/dotnet/api/iserviceprovider">IServiceProvider</a> and fails when it is not registered.
2020

2121
## Layers
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Resolver.appEnv"
3+
linkTitle: "appEnv"
4+
---
5+
6+
<div class="fsdocs-usage">
7+
<code><span>Resolver.appEnv&#32;<span>()</span></span></code>
8+
</div>
9+
10+
Reads the application environment from the environment.
11+
12+
## Remarks
13+
14+
Compatibility alias for the app environment half of <a href="https://learn.microsoft.com/dotnet/api/hostcontext{host, appenv}">HostContext{host, appEnv}</a>.
15+
16+
## Parameters
17+
18+
- `()`: <code>unit</code>
19+

docs/reference/capability/m-resolver-environment.md

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Resolver.host"
3+
linkTitle: "host"
4+
---
5+
6+
<div class="fsdocs-usage">
7+
<code><span>Resolver.host&#32;<span>()</span></span></code>
8+
</div>
9+
10+
Reads the current host from the environment.
11+
12+
## Remarks
13+
14+
Compatibility alias for the host half of <a href="https://learn.microsoft.com/dotnet/api/hostcontext{host, appenv}">HostContext{host, appEnv}</a>.
15+
16+
## Parameters
17+
18+
- `()`: <code>unit</code>
19+

docs/reference/capability/m-resolver-resolve.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ Use this as a compatibility helper or at the boundary where a projection is stil
1515

1616
## Parameters
1717

18-
- `projection`: <code><span>'env&#32;->&#32;'resolve</span></code>
18+
- `projection`: <code><span>'appEnv&#32;->&#32;'resolve</span></code>
1919

docs/reference/capability/m-resolver-runtime.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/reference/host/_index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "HostContext"
3+
---
4+
5+
The `HostContext` type and module split host services from application dependencies and carry the cancellation token for task-based execution. In the current foundation it is the execution carrier above the adapter layer, not the host storage engine.
6+
7+
## Core type
8+
9+
- [`HostContext`](./t-hostcontext-2.md):
10+
Captures the two-context shape of a task workflow execution:
11+
host services, application capabilities, and the cancellation token for the current run.
12+
13+
14+
## Module functions
15+
16+
- [`HostContext.create`](./m-hostcontext-create.md): Creates a host context from the supplied host services, app environment, and cancellation token.
17+
- [`HostContext.host`](./m-hostcontext-host.md): Reads the host half of a host context.
18+
- [`HostContext.appEnv`](./m-hostcontext-appenv.md): Reads the application environment half of a host context.
19+
- [`HostContext.cancellationToken`](./m-hostcontext-cancellationtoken.md): Reads the cancellation token stored in a host context.
20+
- [`HostContext.mapHost`](./m-hostcontext-maphost.md): Maps the host half of a host context.
21+
- [`HostContext.mapAppEnv`](./m-hostcontext-mapappenv.md): Maps the application environment half of a host context.
22+
- [`HostContext.withHost`](./m-hostcontext-withhost.md): Replaces the host half of a host context.
23+
- [`HostContext.withAppEnv`](./m-hostcontext-withappenv.md): Replaces the application environment half of a host context.
24+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "HostContext.appEnv"
3+
linkTitle: "appEnv"
4+
---
5+
6+
<div class="fsdocs-usage">
7+
<code><span>HostContext.appEnv&#32;<span>context</span></span></code>
8+
</div>
9+
10+
Reads the application environment half of a host context.
11+
12+
## Parameters
13+
14+
- `context`: <code><span><a href="https://adz.github.io/FsFlow/reference/FsFlow/fsflow-hostcontext-2.html">HostContext</a>&lt;<span>'host,&#32;'appEnv</span>&gt;</span></code>
15+
The <a href="https://adz.github.io/FsFlow/reference/FsFlow/fsflow-hostcontext-2.html">HostContext</a> to read.
16+
17+
## Returns
18+
19+
The application environment of type <code>&#39;appEnv</code>.
20+

0 commit comments

Comments
 (0)