tweak safety comment

meadowsys · Sep 19, 2024 · 4b21109 · 4b21109
1 parent 4cc4ea4
commit 4b21109
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/string.rs b/src/string.rs
@@ -51,7 +51,9 @@ impl GermanString {
 
  /// # Safety
  ///
- /// `self` must be inline.
+ /// Conservatively marked `unsafe`, `inline` variant has no initialisation
+ /// requirements as long as the first byte is initialised, which all
+ /// constructors of this struct guarantee.
  #[inline]
  unsafe fn to_inline_unchecked(&self) -> &Inline {
  // SAFETY: caller promises the string is stored inline