std::ffi::NulError - Rust
Description: API documentation for the Rust `NulError` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, NulError

# 1.0.0[−][src]Struct std::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();Run

## Methods

### `impl NulError`[src]

#### `pub fn nul_position(&self) -> usize`[src]

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

####
ⓘImportant traits for Vec<u8>

### Important traits for Vec<u8>

`impl Write for Vec<u8>`
`pub fn into_vec(self) -> Vec<u8>`[src]

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");Run

## Trait Implementations

### `impl Error for NulError`[src]

#### `fn description(&self) -> &str`[src]

This method is soft-deprecated. Read more

#### `fn cause(&self) -> Option<&dyn Error>`[src]

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any. Read more

#### `fn source(&self) -> Option<&(dyn Error + 'static)>`1.30.0[src]

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

### `impl PartialEq<NulError> for NulError`[src]

#### `fn eq(&self, other: &NulError) -> bool`[src]

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

#### `fn ne(&self, other: &NulError) -> bool`[src]

This method tests for `!=`.

### `impl Eq for NulError`[src]

### `impl Debug for NulError`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl Display for NulError`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl From<NulError> for Error`[src]

#### `fn from(_: NulError) -> Error`[src]

Converts a `NulError` into a `io::Error`.

### `impl Clone for NulError`[src]

#### `fn clone(&self) -> NulError`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

## Auto Trait Implementations

### `impl UnwindSafe for NulError`

### `impl RefUnwindSafe for NulError`

### `impl Unpin for NulError`

### `impl Sync for NulError`

### `impl Send for NulError`

## Blanket Implementations

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut F

### Important traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut F

### Important traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `default fn to_string(&self) -> String`[src]

Converts the given value to a `String`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)