Mark output-only pub structs non_exhaustive #191

Merged

natsukium merged 1 commit from api/output-structs into main 2026-10-19 17:08:49 +09:00

Conversation 0 Commits 1 Files changed 29 +52

natsukium commented 2026-10-19 13:08:32 +09:00

Owner

Copy link

Pre-publish refactor for #160: #[non_exhaustive] on 52 output-only pub structs, so adding a field to one later is not a semver-major change.

The structs covered are the ones only ever handed out: decoded rows, search hits, mode snapshots, dial results, probes, captures, and the json_v1 DTO structs. The felis_json: 1 contract already allows those DTOs to gain optional fields.

Some structs stay exhaustive:

• Structs a consumer builds with a literal or destructures without .., which includes the sibling repos (felis-tui, felis-reel, spoor, …). They take new fields as 0.x minor bumps.
• AttributesJson, SizingJson, AttrRunJson and SizedCellJson, because the grid proptests build them.
• Diagnostic, because the public ConfigDiagnostics::push takes it as an argument.

Enums are deliberately left exhaustive. In 0.x, a new variant is a cheap 0.(x+1) bump, and that keeps every in-workspace match checked by the compiler. With a #[non_exhaustive] enum, a crate could be built against a newer protocol minor, and then every _ arm would need designed handling for unknown variants.

just check and just check-windows pass.

Pre-publish refactor for #160: `#[non_exhaustive]` on 52 output-only pub structs, so adding a field to one later is not a semver-major change. The structs covered are the ones only ever handed out: decoded rows, search hits, mode snapshots, dial results, probes, captures, and the json_v1 DTO structs. The `felis_json: 1` contract already allows those DTOs to gain optional fields. Some structs stay exhaustive: - Structs a consumer builds with a literal or destructures without `..`, which includes the sibling repos (felis-tui, felis-reel, spoor, …). They take new fields as 0.x minor bumps. - `AttributesJson`, `SizingJson`, `AttrRunJson` and `SizedCellJson`, because the grid proptests build them. - `Diagnostic`, because the public `ConfigDiagnostics::push` takes it as an argument. Enums are deliberately left exhaustive. In 0.x, a new variant is a cheap 0.(x+1) bump, and that keeps every in-workspace `match` checked by the compiler. With a `#[non_exhaustive]` enum, a crate could be built against a newer protocol minor, and then every `_` arm would need designed handling for unknown variants. `just check` and `just check-windows` pass.

natsukium added 1 commit 2026-10-19 13:08:32 +09:00

workspace: mark output-only pub structs non_exhaustive ... 8fe08e62c4

For crates.io publishing, a struct no consumer builds with a literal can
gain a field in a minor release only if it is non_exhaustive. This
covers the structs that are only ever handed out (decoded rows, search
hits, mode snapshots, dial results, probes, captures) and the json_v1
DTO structs, whose felis_json: 1 contract already admits a new optional
field. Structs consumers construct stay exhaustive and take new fields
as 0.x minor bumps; the json_v1 row attribute and sizing DTOs stay
exhaustive because the grid property tests build them.

Assisted-by: Claude Code

natsukium added 1 commit 2026-10-19 14:16:28 +09:00

Merge remote-tracking branch 'origin/main' into api/output-structs 7d3db06cbf

natsukium force-pushed api/output-structs from 7d3db06cbf to 6b5f12c89a 2026-10-19 14:17:46 +09:00 Compare

natsukium merged commit 0289e1e1c7 into main 2026-10-19 17:08:49 +09:00

natsukium deleted branch api/output-structs 2026-10-19 17:08:49 +09:00

natsukium referenced this pull request from a commit 2026-10-19 17:08:50 +09:00

Merge pull request 'Mark output-only pub structs non_exhaustive' (#191) from api/output-structs into main

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

Area/ci

CI workflows (.forgejo/workflows/)

  

Area/cli

felis-cli crate, the felis front-door binary

  

Area/client

felis-client crate, the winit GUI frontend

  

Area/client-core

felis-client-core crate, shadow screen, config, connect_or_spawn_daemon

  

Area/daemon

felis-daemon crate, session pool, IPC server

  

Area/deps

Dependency bumps

  

Area/docs

Documentation tree when no narrower area fits

  

Area/grid

felis-grid crate, cells, scrollback, image store

  

Area/manual

User-facing docs: tutorials, how-to, user-facing reference pages

  

Area/nix

Nix flake, home-manager module, package definitions

  

Area/protocol

felis-protocol crate, felis.proto, frame layout, version constants

  

Area/pty

felis-pty crate, PTY backends

  

Area/render

felis-render-wgpu crate, GPU pipeline, atlas

  

Area/shaping

felis-shaping crate, swash shaper, font fallback

  

Area/skills

Agent skills (skills/felis, .agents/skills/)

  

Area/transport

felis-transport crate, framing, socket/pipe, SSH carrier

  

Area/vt

felis-vt crate, VT parser, dispatch

  

Compat/Breaking

Breaking change that won't be backward compatible

  

Kind/Bug

Something is not working

  

Kind/Documentation

Documentation changes

  

Kind/Enhancement

Improve existing functionality

  

Kind/Feature

New functionality

  

Kind/Performance

Throughput, latency, or memory cost

  

Kind/Security

This is security issue

  

Kind/Testing

Issue or pull request related to testing

  

perf-regression-accepted

Passes the instruction-count bench gate for an intended cost; state why in a PR comment

  

Reviewed

Confirmed

Issue has been confirmed

  

Reviewed

Duplicate

This issue or pull request already exists

  

Reviewed

Invalid

Invalid issue

  

Reviewed

Won't Fix

This issue won't be fixed

  

Status

Blocked

Something is blocking this issue or pull request

  

Status

Need More Info

Feedback is required to reproduce issue or to continue work

  

Status

Upstream

Waiting on a change in an upstream project

No labels

Area/ci

Area/cli

Area/client

Area/client-core

Area/daemon

Area/deps

Area/docs

Area/grid

Area/manual

Area/nix

Area/protocol

Area/pty

Area/render

Area/shaping

Area/skills

Area/transport

Area/vt

Compat/Breaking

Kind/Bug

Kind/Documentation

Kind/Enhancement

Kind/Feature

Kind/Performance

Kind/Security

Kind/Testing

perf-regression-accepted

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Blocked

Status

Need More Info

Status

Upstream

Milestone

Clear milestone

No items

No milestone

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

felis-terminal/felis!191

No description provided.