summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Orlenko <zxteam@protonmail.com>2024-11-09 14:10:45 +0000
committerAlex Orlenko <zxteam@protonmail.com>2024-11-09 14:10:45 +0000
commit958abd050e629c5501c7f802bd890a3b0bdc42a6 (patch)
tree85c152fea7929a0fc1f9f6428061c16c7f46a99f
parent92a8203e1c0ce7a4aa38cb9d68b24b3ec9565620 (diff)
downloadmlua-958abd050e629c5501c7f802bd890a3b0bdc42a6.zip
Update `String::to_string_lossy` doc
-rw-r--r--src/string.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/string.rs b/src/string.rs
index b8fd7c0..04b7ee0 100644
--- a/src/string.rs
+++ b/src/string.rs
@@ -55,7 +55,11 @@ impl String {
///
/// Any non-Unicode sequences are replaced with [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
///
+ /// This method returns [`StdString`] instead of [`Cow<'_, str>`] because lifetime cannot be
+ /// bound to a weak Lua object.
+ ///
/// [U+FFFD]: std::char::REPLACEMENT_CHARACTER
+ /// [`Cow<'_, str>`]: std::borrow::Cow
///
/// # Examples
///