bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

rollup merge of #24350: tbelaire/cstring-doc-from-vec

Browse source 
It looks like `from_vec` was subsumed by new at some point,
but the documentation still refers to it as `from_vec`.

This updates the documentation for `from_vec_unchecked`
so that it properly says that it's the unchecked version of `new`.

Also, from_vec_unchecked requires a actual Vec<u8> while
new can take anything that is Into<Vec<u8>>, so I also
mention that in the documentation.

Since this is documentation:
r? @steveklabnik
This commit is contained in:
Alex Crichton 2015-04-14 10:55:45 -07:00
commit 83d79c6f4c
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/libstd/ffi/c_str.rs
View file

@ -170,8 +170,9 @@ impl CString {
/// Create a C-compatible string from a byte vector without checking for /// Create a C-compatible string from a byte vector without checking for
/// interior 0 bytes. /// interior 0 bytes.
/// ///
/// This method is equivalent to `from_vec` except that no runtime assertion /// This method is equivalent to `new` except that no runtime assertion
/// is made that `v` contains no 0 bytes. /// is made that `v` contains no 0 bytes, and it requires an actual
/// byte vector, not anyhting that can be converted to one with Into.
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub unsafe fn from_vec_unchecked(mut v: Vec<u8>) -> CString { pub unsafe fn from_vec_unchecked(mut v: Vec<u8>) -> CString {
v.push(0); v.push(0);
@ -213,7 +214,7 @@ impl fmt::Debug for CString {
impl NulError { impl NulError {
/// Returns the position of the nul byte in the slice that was provided to /// Returns the position of the nul byte in the slice that was provided to
/// `CString::from_vec`. /// `CString::new`.
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub fn nul_position(&self) -> usize { self.0 } pub fn nul_position(&self) -> usize { self.0 }