Skip to content

std/OsString: Add detailed comment on args meaning #95139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

std/OsString: Add detailed comment on args meaning #95139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions library/std/src/ffi/os_str.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,14 @@ impl OsString {
///
/// See main `OsString` documentation information about encoding.
///
/// # Notes
///
/// `capacity` represents the length of the units in the given `OsString`,
/// which is different from the size of "Rust string form" like `String` or
/// `str`. Also, they could be different on different platforms.
///
/// Refer to [`OsString`] for more details.
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -272,6 +280,14 @@ impl OsString {
/// greater than or equal to `self.len() + additional`. Does nothing if
/// capacity is already sufficient.
///
/// # Notes
///
/// `additional` represents the length of the units in the given `OsString`,
/// which is different from the size of "Rust string form" like `String` or
/// `str`. Also, they could be different on different platforms.
///
/// Refer to [`OsString`] for more details.
///
/// # Errors
///
/// If the capacity overflows, or the allocator reports a failure, then an error
Expand Down