ADD: Add PUBLISHER_SPECIFIC flag

threecgreen · threecgreen · commit 6f6822760f3f · 2025-08-11T22:10:19.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,9 @@
 ## 0.41.0 - TBD
 
 ### Enhancements
-- Add static `Builder()` methods to the clients
-- Improve debug logging in live clients
+- Added static `Builder()` methods to the clients
+- Improved debug logging in live clients
+- Added `PUBLISHER_SPECIFIC` flag
 
 ### Breaking changes
 - Removed unused `Received` variant from `JobState` enum
diff --git a/include/databento/flag_set.hpp b/include/databento/flag_set.hpp
@@ -24,6 +24,8 @@ class FlagSet {
   static constexpr Repr kBadTsRecv = 1 << 3;
   // Indicates an unrecoverable gap was detected in the channel.
   static constexpr Repr kMaybeBadBook = 1 << 2;
+  // Indicates a publisher-specific event.
+  static constexpr Repr kPublisherSpecific = 1 << 1;
 
   friend std::ostream& operator<<(std::ostream&, FlagSet);
 
@@ -77,11 +79,16 @@ class FlagSet {
     bits_.maybe_bad_book = true;
     return *this;
   }
+  constexpr bool IsPublisherSpecific() const { return bits_.publisher_specific; }
+  FlagSet SetPublisherSpecific() {
+    bits_.publisher_specific = true;
+    return *this;
+  }
 
  private:
   struct BitFlags {
     bool reserved0 : 1;
-    bool reserved1 : 1;
+    bool publisher_specific : 1;
     bool maybe_bad_book : 1;
     bool bad_ts_recv : 1;
     bool mbp : 1;
diff --git a/src/flag_set.cpp b/src/flag_set.cpp
@@ -6,14 +6,15 @@
 
 namespace databento {
 std::ostream& operator<<(std::ostream& stream, FlagSet flag_set) {
-  const std::array<std::pair<bool (FlagSet::*)() const, const char*>, 6>
+  const std::array<std::pair<bool (FlagSet::*)() const, const char*>, 7>
       kFlagsAndNames = {{
           {&FlagSet::IsLast, "LAST"},
           {&FlagSet::IsTob, "TOB"},
           {&FlagSet::IsSnapshot, "SNAPSHOT"},
           {&FlagSet::IsMbp, "MBP"},
           {&FlagSet::IsBadTsRecv, "BAD_TS_RECV"},
           {&FlagSet::IsMaybeBadBook, "MAYBE_BAD_BOOK"},
+          {&FlagSet::IsPublisherSpecific, "PUBLISHER_SPECIFIC"},
       }};
 
   bool has_written_flag = false;
diff --git a/tests/src/flag_set_tests.cpp b/tests/src/flag_set_tests.cpp
@@ -46,7 +46,8 @@ TEST(FlagSetTests, ToStringThreeSet) {
 TEST(FlagSetTests, ToStringReservedSet) {
   constexpr FlagSet kTarget{255};
   ASSERT_EQ(ToString(kTarget),
-            "LAST | TOB | SNAPSHOT | MBP | BAD_TS_RECV | MAYBE_BAD_BOOK (255)");
+            "LAST | TOB | SNAPSHOT | MBP | BAD_TS_RECV | MAYBE_BAD_BOOK | "
+            "PUBLISHER_SPECIFIC (255)");
 }
 
 TEST(FlagSetTests, ConstantBitFieldEquivalence) {

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,8 @@ TEST(FlagSetTests, ToStringThreeSet) {`
`46`	`46`	`TEST(FlagSetTests, ToStringReservedSet) {`
`47`	`47`	`constexpr FlagSet kTarget{255};`
`48`	`48`	`ASSERT_EQ(ToString(kTarget),`
`49`		`- "LAST \| TOB \| SNAPSHOT \| MBP \| BAD_TS_RECV \| MAYBE_BAD_BOOK (255)");`
	`49`	`+ "LAST \| TOB \| SNAPSHOT \| MBP \| BAD_TS_RECV \| MAYBE_BAD_BOOK \| "`
	`50`	`+ "PUBLISHER_SPECIFIC (255)");`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`TEST(FlagSetTests, ConstantBitFieldEquivalence) {`