Clippy lint · Restriction · checked with Clippy 0.1.99

clippy::large_include_file: Checks for the inclusion of large files via include_bytes!() or include_str!()

What it meansChecks for the inclusion of large files via include_bytes!() or include_str!(). It is in the restriction group and off by default.

Does it matter?

Including large files can undesirably increase the size of the binary produced by the compiler. This lint may be used to catch mistakes where an unexpectedly large file is included, or temporarily to obtain a list of all large files.

Lints that forbid language features for specific codebases (no unwrap, no indexing...). Off by default; pick them one by one, never the whole group.

How to fix it

Clippy does not fix this one automatically. Change the code by hand:

Flagged

let included_str = include_str!("very_large_file.txt");
let included_bytes = include_bytes!("very_large_file.txt");

Write this instead

use std::fs;

// You can load the file at runtime
let string = fs::read_to_string("very_large_file.txt")?;
let bytes = fs::read("very_large_file.txt")?;

Turn it off, or on

It is off by default. To use it, set it to warn or deny:

Whole crate (Cargo.toml)

[lints.clippy]
large_include_file = "warn"

In code

#![warn(clippy::large_include_file)]

One run

cargo clippy -- -W clippy::large-include-file

The [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.

Settings in clippy.toml

max-include-file-size: The maximum size of a file included via include_bytes!() or include_str!(), in bytes

Restrictiongroup

allowdefault level

nofixed by cargo clippy --fix

1.62.0added in Rust

Clippy's own documentation

What it does

Checks for the inclusion of large files via include_bytes!() or include_str!().

Why restrict this?

Example

let included_str = include_str!("very_large_file.txt");
let included_bytes = include_bytes!("very_large_file.txt");

Use instead:

use std::fs;

// You can load the file at runtime
let string = fs::read_to_string("very_large_file.txt")?;
let bytes = fs::read("very_large_file.txt")?;

Configuration

max-include-file-size: The maximum size of a file included via include_bytes!() or include_str!(), in bytes

(default: 1000000)

From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.

Up next

Also worth your time

Did this answer your question?