Docs4dev
Docs
rust / latest / std / ffi / struct.nulerror.html

Struct std::ffi::NulError

pub struct NulError(/* private fields */);

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

source 
impl NulError
1.0.0source 
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);
1.0.0source 
pub fn into_vec(self) -> Vec<u8> ⓘ

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

source 
impl Clone for NulError
source 
fn clone(&self) -> NulError
Returns a copy of the value. Read more
1.0.0source 
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source 
impl Debug for NulError
source 
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
1.0.0source 
impl Display for NulError
source 
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
1.0.0source 
impl Error for NulError
source 
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.30.0source 
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0source 
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source 
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more
1.0.0source 
impl From<NulError> for Error
source 
fn from(_: NulError) -> Error

Converts a alloc::ffi::NulError into a Error.

source 
impl PartialEq for NulError
source 
fn eq(&self, other: &NulError) -> bool
This method tests for self and other values to be equal, and is used by ==.
1.0.0source 
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source 
impl Eq for NulError
source 
impl StructuralEq for NulError
source 
impl StructuralPartialEq for NulError

Auto Trait Implementations

impl RefUnwindSafe for NulError
impl Send for NulError
impl Sync for NulError
impl Unpin for NulError
impl UnwindSafe for NulError

Blanket Implementations

source 
impl<T> Any for T
where
    T: 'static + ?Sized,
source 
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source 
impl<T> Borrow<T> for T
where
    T: ?Sized,
source 
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source 
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
source 
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source 
impl<T> From<T> for T
source 
fn from(t: T) -> T

Returns the argument unchanged.

source 
impl<T, U> Into<U> for T
where
    U: From<T>,
source 
fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source 
impl<T> ToOwned for T
where
    T: Clone,
 
type Owned = T
The resulting type after obtaining ownership.
source 
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
source 
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more
source 
impl<T> ToString for T
where
    T: Display + ?Sized,
source 
default fn to_string(&self) -> String
Converts the given value to a String. Read more
source 
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
 
type Error = Infallible
The type returned in the event of a conversion error.
source 
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
source 
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
 
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
source 
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ffi/struct.NulError.html