Update Diplomat to new opaque_mut annotations (#7703)

Manishearth · web-flow · commit 9b075f68940c · 2026-02-26T10:08:41.000-08:00
rust-diplomat/diplomat#1065 made Diplomat start enforcing `opaque_mut`. Diplomat doesn't use this to check anything yet, but it's step 1 of the process in making FFI sound.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -213,10 +213,10 @@ icu_benchmark_macros = { path = "tools/benchmark/macros" }
 
 # The version here can either be a `version = ".."` spec or `git = "https://github.com/rust-diplomat/diplomat", rev = ".."`
 # Diplomat must be published preceding a new ICU4X release but may use git versions in between
-diplomat = { git = "https://github.com/rust-diplomat/diplomat", rev = "f71e1b6c562237f9e6059dbf54bfce626936dd35", default-features = false }
-diplomat-runtime = { git = "https://github.com/rust-diplomat/diplomat", rev = "f71e1b6c562237f9e6059dbf54bfce626936dd35", default-features = false }
-diplomat_core = { git = "https://github.com/rust-diplomat/diplomat", rev = "f71e1b6c562237f9e6059dbf54bfce626936dd35", default-features = false }
-diplomat-tool = { git = "https://github.com/rust-diplomat/diplomat", rev = "f71e1b6c562237f9e6059dbf54bfce626936dd35" }
+diplomat = { git = "https://github.com/rust-diplomat/diplomat", rev = "c10e39694cae1026c906111fa2c6c791d7cc6935", default-features = false }
+diplomat-runtime = { git = "https://github.com/rust-diplomat/diplomat", rev = "c10e39694cae1026c906111fa2c6c791d7cc6935", default-features = false }
+diplomat_core = { git = "https://github.com/rust-diplomat/diplomat", rev = "c10e39694cae1026c906111fa2c6c791d7cc6935", default-features = false }
+diplomat-tool = { git = "https://github.com/rust-diplomat/diplomat", rev = "c10e39694cae1026c906111fa2c6c791d7cc6935" }
 
 # EXTERNAL DEPENDENCIES
 #
diff --git a/ffi/capi/bindings/c/TimeZoneInfo.h b/ffi/capi/bindings/c/TimeZoneInfo.h
diff --git a/ffi/capi/bindings/cpp/icu4x/TimeZoneInfo.d.hpp b/ffi/capi/bindings/cpp/icu4x/TimeZoneInfo.d.hpp
diff --git a/ffi/capi/bindings/cpp/icu4x/TimeZoneInfo.hpp b/ffi/capi/bindings/cpp/icu4x/TimeZoneInfo.hpp
diff --git a/ffi/capi/src/bidi.rs b/ffi/capi/src/bidi.rs
@@ -229,7 +229,7 @@ pub mod ffi {
     }
 
     /// Bidi information for a single processed paragraph
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::attr(demo_gen, disable)] // TODO needs custom page
     pub struct BidiParagraph<'info>(pub unicode_bidi::Paragraph<'info, 'info>);
 
diff --git a/ffi/capi/src/collections_sets.rs b/ffi/capi/src/collections_sets.rs
@@ -9,7 +9,7 @@ pub mod ffi {
 
     use crate::unstable::properties_sets::ffi::CodePointSetData;
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(
         icu::collections::codepointinvlist::CodePointInversionListBuilder,
         Struct
diff --git a/ffi/capi/src/fallbacker.rs b/ffi/capi/src/fallbacker.rs
@@ -53,7 +53,7 @@ pub mod ffi {
     );
 
     /// An iterator over the locale under fallback.
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::locale::fallback::LocaleFallbackIterator, Struct)]
     pub struct LocaleFallbackIterator<'a>(pub icu_locale::fallback::LocaleFallbackIterator<'a>);
 
diff --git a/ffi/capi/src/fixed_decimal.rs b/ffi/capi/src/fixed_decimal.rs
@@ -13,7 +13,7 @@ pub mod ffi {
 
     use writeable::Writeable;
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(fixed_decimal::Decimal, Typedef)]
     pub struct Decimal(pub fixed_decimal::Decimal);
 
diff --git a/ffi/capi/src/iana_parser.rs b/ffi/capi/src/iana_parser.rs
@@ -59,7 +59,7 @@ pub mod ffi {
         }
     }
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::time::zone::iana::TimeZoneIter, Struct)]
     pub struct TimeZoneIterator<'a>(icu_time::zone::iana::TimeZoneIter<'a>);
 
@@ -160,7 +160,7 @@ pub mod ffi {
         canonical: DiplomatUtf8StrSlice<'a>,
     }
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalIter, Struct)]
     pub struct TimeZoneAndCanonicalIterator<'a>(icu_time::zone::iana::TimeZoneAndCanonicalIter<'a>);
 
@@ -188,7 +188,7 @@ pub mod ffi {
         normalized: DiplomatUtf8StrSlice<'a>,
     }
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter, Struct)]
     pub struct TimeZoneAndCanonicalAndNormalizedIterator<'a>(
         icu_time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter<'a>,
diff --git a/ffi/capi/src/locale_core.rs b/ffi/capi/src/locale_core.rs
@@ -11,7 +11,7 @@ pub mod ffi {
 
     use writeable::Writeable;
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     /// An ICU4X Locale, capable of representing strings like `"en-US"`.
     #[diplomat::rust_link(icu::locale::Locale, Struct)]
     #[diplomat::rust_link(icu::locale::DataLocale, Struct, hidden)]
diff --git a/ffi/capi/src/properties_iter.rs b/ffi/capi/src/properties_iter.rs
@@ -24,7 +24,7 @@ pub mod ffi {
 
     /// An iterator over code point ranges, produced by `CodePointSetData` or
     /// one of the `CodePointMapData` types
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     pub struct CodePointRangeIterator<'a>(
         pub Box<dyn Iterator<Item = RangeInclusive<DiplomatChar>> + 'a>,
     );
diff --git a/ffi/capi/src/provider.rs b/ffi/capi/src/provider.rs
@@ -12,7 +12,7 @@ pub mod ffi {
 
     use crate::unstable::errors::ffi::DataError;
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     /// An ICU4X data provider, capable of loading ICU4X data keys from some source.
     ///
     /// Currently the only source supported is loading from "blob" formatted data from a bytes buffer or the file system.
diff --git a/ffi/capi/src/segmenter_grapheme.rs b/ffi/capi/src/segmenter_grapheme.rs
@@ -18,21 +18,21 @@ pub mod ffi {
     #[diplomat::rust_link(icu::segmenter::GraphemeClusterSegmenterBorrowed, Struct, hidden)]
     pub struct GraphemeClusterSegmenter(icu_segmenter::GraphemeClusterSegmenter);
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::GraphemeClusterBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct GraphemeClusterBreakIteratorUtf8<'a>(
         icu_segmenter::iterators::GraphemeClusterBreakIterator<'a, 'a, PotentiallyIllFormedUtf8>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::GraphemeClusterBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct GraphemeClusterBreakIteratorUtf16<'a>(
         icu_segmenter::iterators::GraphemeClusterBreakIterator<'a, 'a, Utf16>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::GraphemeClusterBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct GraphemeClusterBreakIteratorLatin1<'a>(
diff --git a/ffi/capi/src/segmenter_line.rs b/ffi/capi/src/segmenter_line.rs
@@ -16,7 +16,7 @@ pub mod ffi {
     #[cfg(any(feature = "compiled_data", feature = "buffer_provider"))]
     use icu_segmenter::options::LineBreakOptions;
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut] // TODO (#7704): This is unsound
     /// An ICU4X line-break segmenter, capable of finding breakpoints in strings.
     #[diplomat::rust_link(icu::segmenter::LineSegmenter, Struct)]
     #[diplomat::rust_link(icu::segmenter::LineSegmenterBorrowed, Struct, hidden)]
@@ -52,21 +52,21 @@ pub mod ffi {
         pub word_option: DiplomatOption<LineBreakWordOption>,
     }
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::LineBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct LineBreakIteratorUtf8<'a>(
         icu_segmenter::iterators::LineBreakIterator<'a, 'a, PotentiallyIllFormedUtf8>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::LineBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct LineBreakIteratorUtf16<'a>(
         icu_segmenter::iterators::LineBreakIterator<'a, 'a, Utf16>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::LineBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct LineBreakIteratorLatin1<'a>(
diff --git a/ffi/capi/src/segmenter_sentence.rs b/ffi/capi/src/segmenter_sentence.rs
@@ -19,21 +19,21 @@ pub mod ffi {
     #[diplomat::rust_link(icu::segmenter::SentenceSegmenterBorrowed, Struct, hidden)]
     pub struct SentenceSegmenter(icu_segmenter::SentenceSegmenter);
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::SentenceBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct SentenceBreakIteratorUtf8<'a>(
         icu_segmenter::iterators::SentenceBreakIterator<'a, 'a, PotentiallyIllFormedUtf8>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::SentenceBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct SentenceBreakIteratorUtf16<'a>(
         icu_segmenter::iterators::SentenceBreakIterator<'a, 'a, Utf16>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::SentenceBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct SentenceBreakIteratorLatin1<'a>(
diff --git a/ffi/capi/src/segmenter_word.rs b/ffi/capi/src/segmenter_word.rs
@@ -24,27 +24,27 @@ pub mod ffi {
         Letter = 2,
     }
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut] // TODO (#7704): This is unsound
     /// An ICU4X word-break segmenter, capable of finding word breakpoints in strings.
     #[diplomat::rust_link(icu::segmenter::WordSegmenter, Struct)]
     #[diplomat::rust_link(icu::segmenter::WordSegmenterBorrowed, Struct, hidden)]
     #[diplomat::demo(custom_func = "../../../tools/web-demo/custom/WordSegmenter.mjs")]
     pub struct WordSegmenter(icu_segmenter::WordSegmenter);
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::WordBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct WordBreakIteratorUtf8<'a>(
         icu_segmenter::iterators::WordBreakIterator<'a, 'a, PotentiallyIllFormedUtf8>,
     );
 
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::WordBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct WordBreakIteratorUtf16<'a>(
         icu_segmenter::iterators::WordBreakIterator<'a, 'a, Utf16>,
     );
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     #[diplomat::rust_link(icu::segmenter::iterators::WordBreakIterator, Struct)]
     #[diplomat::attr(demo_gen, disable)] // iterator type
     pub struct WordBreakIteratorLatin1<'a>(
diff --git a/ffi/capi/src/timezone.rs b/ffi/capi/src/timezone.rs
@@ -283,7 +283,7 @@ pub mod ffi {
         #[diplomat::rust_link(icu::time::zone::TimeZoneVariant, Enum, compact)]
         #[allow(deprecated)]
         pub fn infer_variant(
-            &mut self,
+            &self,
             _offset_calculator: &crate::unstable::variant_offset::ffi::VariantOffsetsCalculator,
         ) -> Option<()> {
             Some(())
diff --git a/ffi/capi/src/week.rs b/ffi/capi/src/week.rs
@@ -70,7 +70,7 @@ pub mod ffi {
 
     /// Documents which days of the week are considered to be a part of the weekend
     #[diplomat::rust_link(icu::calendar::week::WeekdaySetIterator, Struct)]
-    #[diplomat::opaque]
+    #[diplomat::opaque_mut]
     pub struct WeekdaySetIterator(icu_calendar::week::WeekdaySetIterator);
 
     impl WeekdaySetIterator {

Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ pub mod ffi {`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`/// Bidi information for a single processed paragraph`
`232`		`- #[diplomat::opaque]`
	`232`	`+ #[diplomat::opaque_mut]`
`233`	`233`	`#[diplomat::attr(demo_gen, disable)] // TODO needs custom page`
`234`	`234`	`pub struct BidiParagraph<'info>(pub unicode_bidi::Paragraph<'info, 'info>);`
`235`	`235`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ pub mod ffi {`
`59`	`59`	`}`
`60`	`60`	`}`
`61`	`61`
`62`		`- #[diplomat::opaque]`
	`62`	`+ #[diplomat::opaque_mut]`
`63`	`63`	`#[diplomat::rust_link(icu::time::zone::iana::TimeZoneIter, Struct)]`
`64`	`64`	`pub struct TimeZoneIterator<'a>(icu_time::zone::iana::TimeZoneIter<'a>);`
`65`	`65`
`@@ -160,7 +160,7 @@ pub mod ffi {`
`160`	`160`	`canonical: DiplomatUtf8StrSlice<'a>,`
`161`	`161`	`}`
`162`	`162`
`163`		`- #[diplomat::opaque]`
	`163`	`+ #[diplomat::opaque_mut]`
`164`	`164`	`#[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalIter, Struct)]`
`165`	`165`	`pub struct TimeZoneAndCanonicalIterator<'a>(icu_time::zone::iana::TimeZoneAndCanonicalIter<'a>);`
`166`	`166`
`@@ -188,7 +188,7 @@ pub mod ffi {`
`188`	`188`	`normalized: DiplomatUtf8StrSlice<'a>,`
`189`	`189`	`}`
`190`	`190`
`191`		`- #[diplomat::opaque]`
	`191`	`+ #[diplomat::opaque_mut]`
`192`	`192`	`#[diplomat::rust_link(icu::time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter, Struct)]`
`193`	`193`	`pub struct TimeZoneAndCanonicalAndNormalizedIterator<'a>(`
`194`	`194`	`icu_time::zone::iana::TimeZoneAndCanonicalAndNormalizedIter<'a>,`