context

Types

Context

opaque </>

Context for code generation, carrying all needed state. Only accepts a resolved spec — codegen must not operate on unresolved ASTs.

Opaque: external callers construct via new/2 and read fields via the accessors spec/1 / config/1. This keeps the internal shape free to evolve (e.g. add derived caches) without rippling into every pattern match across the codebase.

pub opaque type Context

FileTarget

</>

Target for a generated file, indicating where it should be written.

pub type FileTarget {
  SharedTarget
  ServerTarget
  ClientTarget
}

Constructors

```
SharedTarget
```
```
ServerTarget
```
```
ClientTarget
```

GeneratedFile

</>

A generated file with its path, content, output target, and write mode. write_mode defaults to Overwrite for every file the generator owns end-to-end.

pub type GeneratedFile {
  GeneratedFile(
    path: String,
    content: String,
    target: FileTarget,
    write_mode: WriteMode,
  )
}

Constructors

GeneratedFile(
  path: String,
  content: String,
  target: FileTarget,
  write_mode: WriteMode,
)

WriteMode

</>

How the writer should treat a GeneratedFile that already exists on disk. Most generated files are sealed (Overwrite) — the user is expected not to touch them and the generator clobbers any local changes on every run. SkipIfExists is for files the generator emits ONCE as a starting point, then leaves alone so the user can own the contents (Issue #247: handlers.gleam panic stubs).

pub type WriteMode {
  Overwrite
  SkipIfExists
}

Constructors

```
Overwrite
```
```
SkipIfExists
```

Values

config

</>

pub fn config(ctx: Context) -> config.Config

The generation config this context wraps.

new

</>

pub fn new(
  spec: spec.OpenApiSpec(spec.Resolved),
  config: config.Config,
) -> Context

Create a new generation context from a resolved spec.

spec

</>

pub fn spec(ctx: Context) -> spec.OpenApiSpec(spec.Resolved)

The resolved OpenAPI spec this context wraps.

version

</>

pub const version: String

The version of oaspec used for generated code headers.