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

# Struct std::io::StdinLock 1.0.0 [−] [src]

    pub struct StdinLock<'a> { /* fields omitted */ }

A locked reference to the `Stdin` handle.

This handle implements both the `Read` and `BufRead` traits, and is constructed via the `Stdin::lock` method.

## Trait Implementations

### `impl<'a> Read for StdinLock<'a>`
[src]

#### `fn read(&mut self, buf: &mut [u8]) -> Result<usize>`

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

#### `fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>`

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_to_string(&mut self, buf: &mut String) -> Result<usize>`

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>`
1.6.0

Read the exact number of bytes required to fill `buf`. Read more

#### `fn by_ref(&mut self) -> &mut Self where Self: Sized`

Creates a "by reference" adaptor for this instance of `Read`. Read more

#### `fn bytes(self) -> Bytes<Self> where Self: Sized`

Transforms this `Read` instance to an `Iterator` over its bytes. Read more

#### `fn chars(self) -> Chars<Self> where Self: Sized`

🔬 This is a nightly-only experimental API. (`io` #27802)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this `Read` instance to an `Iterator` over `char`s. Read more

#### `fn chain<R: Read>(self, next: R) -> Chain<Self, R> where Self: Sized`

Creates an adaptor which will chain this stream with another. Read more

#### `fn take(self, limit: u64) -> Take<Self> where Self: Sized`

Creates an adaptor which will read at most `limit` bytes from it. Read more

### `impl<'a> BufRead for StdinLock<'a>`
[src]

#### `fn fill_buf(&mut self) -> Result<&[u8]>`

Fills the internal buffer of this object, returning the buffer contents. Read more

#### `fn consume(&mut self, n: usize)`

Tells this buffer that `amt` bytes have been consumed from the buffer, so they should no longer be returned in calls to `read`. Read more

#### `fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>`

Read all bytes into `buf` until the delimiter `byte` or EOF is reached. Read more

#### `fn read_line(&mut self, buf: &mut String) -> Result<usize>`

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more

#### `fn split(self, byte: u8) -> Split<Self> where Self: Sized`

Returns an iterator over the contents of this reader split on the byte `byte`. Read more

#### `fn lines(self) -> Lines<Self> where Self: Sized`

Returns an iterator over the lines of this reader. Read more

### `impl<'a> Debug for StdinLock<'a>`
1.15.0
[src]

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

Formats the value using the given formatter.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)