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

# [−][src]Struct std::io::Initializer

    pub struct Initializer(_);

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

A type used to conditionally initialize buffers passed to `Read` methods.

## Methods

### `impl Initializer`[src]

#### `pub fn zeroing() -> Initializer`[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Returns a new `Initializer` which will zero out buffers.

#### `pub unsafe fn nop() -> Initializer`[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Returns a new `Initializer` which will not zero out buffers.

# Safety

This may only be called by `Read`ers which guarantee that they will not read from buffers passed to `Read` methods, and that the return value of the method accurately reflects the number of bytes that have been written to the head of the buffer.

#### `pub fn should_initialize(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Indicates if a buffer should be initialized.

#### `pub fn initialize(&self, buf: &mut [u8])`[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Initializes a buffer if necessary.

## Trait Implementations

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

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl Send for Initializer`

### `impl Sync for Initializer`

## Blanket Implementations

### `impl<T, U> TryFrom 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> From for T`[src]

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

Performs the conversion.

### `impl<T, U> TryInto 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, U> Into for T where
U: From<T>,` [src]

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

Performs the conversion.

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

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

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;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 for T where
T: ?Sized,` [src]

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

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;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

# 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`)