Struct rustix::ffi::NulError

pub struct NulError(_, _);

An error indicating that an interior nul byte was found.

While Rust strings may contain nul bytes in the middle, C strings can’t, as that byte would effectively truncate the string.

This error is created by the new method on CString. See its documentation for more.

Examples

use std::ffi::{CString, NulError};

let _: NulError = CString::new(b"f\0oo".to_vec()).unwrap_err();

Implementations

impl NulError

pub fn nul_position(&self) -> usize

Returns the position of the nul byte in the slice that caused CString::new to fail.

Examples

use std::ffi::CString;

let nul_error = CString::new("foo\0bar").unwrap_err();
assert_eq!(nul_error.nul_position(), 3);

let nul_error = CString::new("foo bar\0").unwrap_err();
assert_eq!(nul_error.nul_position(), 7);

pub fn into_vec(self) -> Vec<u8, Global>

Consumes this error, returning the underlying vector of bytes which generated the error in the first place.

Examples

use std::ffi::CString;

let nul_error = CString::new("foo\0bar").unwrap_err();
assert_eq!(nul_error.into_vec(), b"foo\0bar");

Trait Implementations

impl Clone for NulError

fn clone(&self) -> NulError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NulError

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

Formats the value using the given formatter.

impl Display for NulError

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

Formats the value using the given formatter.

impl Error for NulError

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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)

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

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<NulError> for NulError

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

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

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

This method tests for !=.

impl Eq for NulError

impl StructuralEq for NulError

impl StructuralPartialEq for NulError