core::include_str - Rust
Description: API documentation for the Rust `include_str` macro in crate `core`.
Keywords: rust, rustlang, rust-lang, include_str

# 1.0.0[−][src]Macro core::include_str

    macro_rules! include_str {
        ($file:expr) => { ... };
        ($file:expr,) => { ... };
    }

Includes a utf8-encoded file as a string.

The file is located relative to the current file. (similarly to how modules are found)

This macro will yield an expression of type `&'static str` which is the contents of the file.

# Examples

Assume there are two files in the same directory with the following contents:

File 'spanish.in':

    adiós

File 'main.rs':

ⓘThis example is not tested

    fn main() {
        let my_str = include_str!("spanish.in");
        assert_eq!(my_str, "adiós\n");
        print!("{}", my_str);
    }Run

Compiling 'main.rs' and running the resulting binary will print "adiós".

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