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

# 1.0.0[−][src]Type Definition std::io::Result

    type Result<T> = Result<T, Error>;

A specialized `Result` type for I/O operations.

This type is broadly used across `std::io` for any operation which may produce an error.

This typedef is generally used to avoid writing out `io::Error` directly and is otherwise a direct mapping to `Result`.

While usual Rust style is to import types directly, aliases of `Result` often are not, to make it easier to distinguish between them. `Result` is generally assumed to be `std::result::Result`, and so users of this alias will generally use `io::Result` instead of shadowing the prelude's import of `std::result::Result`.

# Examples

A convenience function that bubbles an `io::Result` to its caller:

    use std::io;

    fn get_string() -> io::Result<String> {
        let mut buffer = String::new();

        io::stdin().read_line(&mut buffer)?;

        Ok(buffer)
    }Run

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