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

# Macro std::include_bytes 1.0.0 [−] [src]

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

Includes a file as a reference to a byte array.

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

This macro will yield an expression of type `&'static [u8; N]` 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':

    fn main() {
        let bytes = include_bytes!("spanish.in");
        assert_eq!(bytes, b"adi\xc3\xb3s\n");
        print!("{}", String::from_utf8_lossy(bytes));
    }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
⏎
  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`)