std::fs::read_to_string - Rust
Description: API documentation for the Rust `read_to_string` fn in crate `std`.
Keywords: rust, rustlang, rust-lang, read_to_string

# 1.26.0[−][src]Function std::fs::read_to_string

    pub fn read_to_string<P: AsRef<Path>>(path: P) -> Result<String>

Read the entire contents of a file into a string.

This is a convenience function for using `File::open` and `read_to_string` with fewer imports and without an intermediate variable. It pre-allocates a buffer based on the file size when available, so it is generally faster than reading into a string created with `String::new()`.

# Errors

This function will return an error if `path` does not already exist. Other errors may also be returned according to `OpenOptions::open`.

It will also return an error if it encounters while reading an error of a kind other than `ErrorKind::Interrupted`, or if the contents of the file are not valid UTF-8.

# Examples

    use std::fs;
    use std::net::SocketAddr;

    fn main() -> Result<(), Box<dyn std::error::Error + 'static>> {
        let foo: SocketAddr = fs::read_to_string("address.txt")?.parse()?;
        Ok(())
    }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`)