Struct std::ffi::FromVecWithNulError

pub struct FromVecWithNulError { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (cstring_from_vec_with_nul #73179)

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 CString::from_vec_with_nul method. See its documentation for more.

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();

Implementations

impl FromVecWithNulError

pub fn as_bytes(&self) -> &[u8]

🔬 This is a nightly-only experimental API. (cstring_from_vec_with_nul #73179)

Returns a slice of u8s 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());

pub fn into_bytes(self) -> Vec<u8>

🔬 This is a nightly-only experimental API. (cstring_from_vec_with_nul #73179)

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());

Trait Implementations

impl Clone for FromVecWithNulError

fn clone(&self) -> FromVecWithNulError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FromVecWithNulError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for FromVecWithNulError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for FromVecWithNulError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace #53487)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<FromVecWithNulError> for FromVecWithNulError

fn eq(&self, other: &FromVecWithNulError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FromVecWithNulError) -> bool

This method tests for !=.

impl Eq for FromVecWithNulError

impl StructuralEq for FromVecWithNulError

impl StructuralPartialEq for FromVecWithNulError