Add a new error type for the new method
This commit is contained in:
parent
5f4eb27a0d
commit
685f06612d
@ -260,6 +260,32 @@ pub struct FromBytesWithNulError {
|
||||
kind: FromBytesWithNulErrorKind,
|
||||
}
|
||||
|
||||
/// An error indicating that a nul byte was not in the expected position.
|
||||
///
|
||||
/// The vector used to create a [`CString`] must have one and only one nul byte,
|
||||
/// positioned at the end.
|
||||
///
|
||||
/// This error is created by the [`from_vec_with_nul`] method on [`CString`].
|
||||
/// See its documentation for more.
|
||||
///
|
||||
/// [`CString`]: struct.CString.html
|
||||
/// [`from_vec_with_nul`]: struct.CString.html#method.from_vec_with_nul
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(cstring_from_vec_with_nul)]
|
||||
/// use std::ffi::{CString, FromVecWithNulError};
|
||||
///
|
||||
/// let _: FromVecWithNulError = CString::from_vec_with_nul(b"f\0oo".to_vec()).unwrap_err();
|
||||
/// ```
|
||||
#[derive(Clone, PartialEq, Eq, Debug)]
|
||||
#[unstable(feature = "cstring_from_vec_with_nul", issue = "73179")]
|
||||
pub struct FromVecWithNulError {
|
||||
error_kind: FromBytesWithNulErrorKind,
|
||||
bytes: Vec<u8>,
|
||||
}
|
||||
|
||||
#[derive(Clone, PartialEq, Eq, Debug)]
|
||||
enum FromBytesWithNulErrorKind {
|
||||
InteriorNul(usize),
|
||||
@ -275,6 +301,59 @@ impl FromBytesWithNulError {
|
||||
}
|
||||
}
|
||||
|
||||
#[unstable(feature = "cstring_from_vec_with_nul", issue = "73179")]
|
||||
impl FromVecWithNulError {
|
||||
/// Returns a slice of [`u8`]s bytes that were attempted to convert to a [`CString`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Basic usage:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(cstring_from_vec_with_nul)]
|
||||
/// use std::ffi::CString;
|
||||
///
|
||||
/// // Some invalid bytes in a vector
|
||||
/// let bytes = b"f\0oo".to_vec();
|
||||
///
|
||||
/// let value = CString::from_vec_with_nul(bytes.clone());
|
||||
///
|
||||
/// assert_eq!(&bytes[..], value.unwrap_err().as_bytes());
|
||||
/// ```
|
||||
///
|
||||
/// [`CString`]: struct.CString.html
|
||||
pub fn as_bytes(&self) -> &[u8] {
|
||||
&self.bytes[..]
|
||||
}
|
||||
|
||||
/// Returns the bytes that were attempted to convert to a [`CString`].
|
||||
///
|
||||
/// This method is carefully constructed to avoid allocation. It will
|
||||
/// consume the error, moving out the bytes, so that a copy of the bytes
|
||||
/// does not need to be made.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Basic usage:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(cstring_from_vec_with_nul)]
|
||||
/// use std::ffi::CString;
|
||||
///
|
||||
/// // Some invalid bytes in a vector
|
||||
/// let bytes = b"f\0oo".to_vec();
|
||||
///
|
||||
/// let value = CString::from_vec_with_nul(bytes.clone());
|
||||
///
|
||||
/// assert_eq!(bytes, value.unwrap_err().into_bytes());
|
||||
/// ```
|
||||
///
|
||||
/// [`CString`]: struct.CString.html
|
||||
pub fn into_bytes(self) -> Vec<u8> {
|
||||
self.bytes
|
||||
}
|
||||
}
|
||||
|
||||
/// An error indicating invalid UTF-8 when converting a [`CString`] into a [`String`].
|
||||
///
|
||||
/// `CString` is just a wrapper over a buffer of bytes with a nul
|
||||
@ -1039,6 +1118,23 @@ impl fmt::Display for FromBytesWithNulError {
|
||||
}
|
||||
}
|
||||
|
||||
#[unstable(feature = "cstring_from_vec_with_nul", issue = "73179")]
|
||||
impl Error for FromVecWithNulError {}
|
||||
|
||||
#[unstable(feature = "cstring_from_vec_with_nul", issue = "73179")]
|
||||
impl fmt::Display for FromVecWithNulError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match self.error_kind {
|
||||
FromBytesWithNulErrorKind::InteriorNul(pos) => {
|
||||
write!(f, "data provided contains an interior nul byte at pos {}", pos)
|
||||
}
|
||||
FromBytesWithNulErrorKind::NotNulTerminated => {
|
||||
write!(f, "data provided is not nul terminated")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl IntoStringError {
|
||||
/// Consumes this error, returning original [`CString`] which generated the
|
||||
/// error.
|
||||
|
@ -157,6 +157,8 @@
|
||||
|
||||
#[stable(feature = "cstr_from_bytes", since = "1.10.0")]
|
||||
pub use self::c_str::FromBytesWithNulError;
|
||||
#[unstable(feature = "cstring_from_vec_with_nul", issue = "73179")]
|
||||
pub use self::c_str::FromVecWithNulError;
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub use self::c_str::{CStr, CString, IntoStringError, NulError};
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user