wboayue / rust-ibapi / 26005329721

92%

push

github

connection!: remove StartupMessage::Other; narrow ResponseMessage to pub(crate) (#581)

* connection!: remove StartupMessage::Other; narrow ResponseMessage to pub(crate)

PR 3 of plans/retire-response-message-public-surface.md. Three coupled
changes that finally retire ResponseMessage from the public surface:

1. StartupMessage::Other(ResponseMessage) removed. Unknown handshake
   frame kinds and typed-decoder failures now route to the notice
   stream (Client::notice_stream()) with synthesized codes:
   - HANDSHAKE_UNKNOWN_FRAME_CODE = -3 (TWS schema drift)
   - HANDSHAKE_DECODE_FAILURE_CODE = -4 (decoder bug)
   New Notice::is_handshake_synthetic() predicate distinguishes them
   from TWS-emitted notices.

2. ResponseMessage crate-root re-export dropped from src/lib.rs and
   the type narrowed to pub(crate). The struct was wire plumbing;
   downstream code never had a reason to reach it.

3. Error::UnexpectedResponse(ResponseMessage) → UnexpectedResponse(String).
   The string carries the Debug repr for diagnostic logging; the
   structured payload is no longer exposed. matches!(err,
   UnexpectedResponse(_)) keeps working. 41 internal callsites switch
   to a new Error::unexpected_response(&ResponseMessage) helper.

TickDecoder trait kept pub (it's a bound on the public TickSubscription
type) but its decode method gets #[allow(private_interfaces)] — external
users cannot construct &mut ResponseMessage, so the method is
effectively crate-private.

Migration guide: docs/migration-3.0.md updated; sections 6 and 17
reflect the narrowed surface. PR 1 capture artifact
(examples/async/startup_capture.rs) deleted — its discovery mission is
complete and the example referenced the removed Other variant.

Tests: lib 1224 (async) / 1510 (sync) / 1511 (all-features); doctests
134/210/210. Three connect/reconnect tests reshaped to use the
OpenOrderEnd unit marker instead of sparse-frame fall-through, since
sparse-frame decode failures no longer route through the... (continued)

63 of 87 new or added lines in 18 files covered. (72.41%)

18979 of 20603 relevant lines covered (92.12%)

27.81 hits per line