Repository navigation
6.0: Client bool flags become ApiOnly, AutoBind, AllMessages enums - #1257
Open
tradatious wants to merge 1 commit into
Open
tradatious wants to merge 1 commit into
tradatious wants to merge 1 commit into
Conversation
completed_orders, auto_open_orders and news_bulletins (sync and async) take orders::ApiOnly, orders::AutoBind and news::AllMessages (Yes / No) instead of a bool, as LedgerOnly, SmartDepth and IgnoreSize do, so the call site says what the flag selects. Encoders, rustdoc, prelude, examples, integration tests and CHANGELOG follow. Migration §41.
tradatious
force-pushed
the
api_b_flag-enums
branch
from
November 16, 2026 18:47
144cab2 to
cea130b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
completed_orders(api_only),auto_open_orders(auto_bind)andnews_bulletins(all_messages)were the lastClientmethods taking a barebool, so a call readclient.completed_orders(true). They now takeorders::ApiOnly,orders::AutoBindandnews::AllMessages(Yes/No, noDefault), the shapeLedgerOnly,SmartDepthandIgnoreSizehave.Yesis the oldtrue; nothing changes on the wire.ApiOnlyandAutoBindjoin the prelude beside the other order types. The async rustdoc ofcompleted_ordersandnews_bulletinsgains the# Argumentsblock the blocking one has.Testing
cargo fmt --checkcargo clippy --all-targets -- -D warningscargo clippy --all-targets --no-default-features --features sync -- -D warningscargo clippy --all-targets --all-features -- -D warningsRUSTDOCFLAGS="-D warnings" cargo doc --no-depsRUSTDOCFLAGS="-D warnings" cargo doc --no-deps --no-default-features --features syncRUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-featurescargo test --all-featurescargo clippy -p ibapi-integration-sync --tests -- -D warningscargo clippy -p ibapi-integration-async --tests -- -D warningsNot tested live: the change is to the argument type only, and the encoder tests check both variants of each flag against the request bytes.
Breaking changes
Yes. Calls to the three methods pass the enum variant instead of
true/false; the compiler reports each one. Migration §41 (numbered after #1254's §40).