wboayue / rust-ibapi / 25419016477

92%

push

github

feat(orders)!: type OrderStatus.status / OrderState.status as OrderStatusKind (#518)

* feat(orders)!: type OrderStatus.status / OrderState.status as OrderStatusKind

Replace stringly-typed status fields with a strict OrderStatusKind enum (9 variants matching IB C# OrderStatus). Adds Display, FromStr, and is_active/is_terminal helpers mirroring C# OrderStatusUtils.

OrderState.completed_status stays String -- wire data is free-form descriptive text (e.g. Cancelled by Trader, Filled Size: 1), not enum vocabulary.

Examples now use status.is_terminal() instead of magic-string compares.

Breaking change for v3.0.

* docs: README + migration guide for OrderStatusKind; CLAUDE.md doc-sync rule

README: drop dead OrderUpdate::Message arms (removed in #517); show is_terminal() in order-update examples.

docs/migration-3.0.md: new section for OrderStatus.status / OrderState.status -> OrderStatusKind; documents per-T Notice/Message variant removal; update PlaceOrder example; expand checklist.

CLAUDE.md: explicit rule to update README + docs/migration-3.0.md in the same PR as any v3.0 breaking change; mechanical grep check before opening PR.

* test(orders): unit-test triple for OrderStatusKind; expand variant docs

Three tests in src/orders/tests.rs:

- order_status_kind_from_str_round_trips_for_all_variants: each of 9 variants parses + Display round-trips through FromStr (catches mapping typos)

- order_status_kind_from_str_rejects_unknown_status: unknown string surfaces as Error::Parse with the offending value (catches silent decode regressions)

- is_active_and_is_terminal_partition_eight_of_nine_variants: exhaustive match asserts each variant lands in exactly the right helper bucket; ApiPending falls outside both per the documented gap

Variant docs expanded to preserve the IB-reference detail that was previously inline on OrderStatus.status (election criteria for PreSubmitted, transitional ApiCancelled, market-order Filled caveat). Restores informational ... (continued)

58 of 58 new or added lines in 4 files covered. (100.0%)

17577 of 19970 relevant lines covered (88.02%)

33.42 hits per line