Clippy lints / Nursery
Clippy lint · Nursery · checked with Clippy 0.1.99
clippy::string_lit_as_bytes: Checks for the as_bytes method called on string literals that contain only ASCII characters
What it meansChecks for the as_bytes method called on string literals that contain only ASCII characters. It is in the nursery group and off by default.
Does it matter?
Byte string literals (e.g., b"foo") can be used instead. They are shorter but less discoverable than as_bytes().
New lints still being finished. Off by default and may have false positives.
How to fix it
Clippy can fix this one for you: run cargo clippy --fix (add --allow-dirty if you have uncommitted changes). Review the diff before you commit.
Flagged
fn f(v: Vec<u8>) {}
f("...".as_bytes().to_owned()); // works
f(b"...".to_owned()); // does not work, because arg is [u8; 3] not Vec<u8>
fn g(r: impl std::io::Read) {}
g("...".as_bytes()); // works
g(b"..."); // does not work
Write this instead
let bstr = "a byte string".as_bytes();
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]
string_lit_as_bytes = "warn"In code
#![warn(clippy::string_lit_as_bytes)]One run
cargo clippy -- -W clippy::string-lit-as-bytesThe [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.
Clippy's own documentation
What it does
Checks for the as_bytes method called on string literals
that contain only ASCII characters.
Why is this bad?
Byte string literals (e.g., b"foo") can be used
instead. They are shorter but less discoverable than as_bytes().
Known problems
"str".as_bytes() and the suggested replacement of b"str" are not
equivalent because they have different types. The former is &[u8]
while the latter is &[u8; 3]. That means in general they will have a
different set of methods and different trait implementations.
fn f(v: Vec<u8>) {}
f("...".as_bytes().to_owned()); // works
f(b"...".to_owned()); // does not work, because arg is [u8; 3] not Vec<u8>
fn g(r: impl std::io::Read) {}
g("...".as_bytes()); // works
g(b"..."); // does not work
The actual equivalent of "str".as_bytes() with the same type is not
b"str" but &b"str"[..], which is a great deal of punctuation and not
more readable than a function call.
Example
let bstr = "a byte string".as_bytes();
Use instead:
let bstr = b"a byte string";
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- redundant_cloneChecks for a redundant clone() (and its relatives) which clones an owned value that is going to be dropped without further use
- significant_drop_in_scrutineeChecks for temporaries returned from function calls in a match scrutinee that have the clippy::has_significant_drop attribute
- significant_drop_tighteningSearches for elements marked with #[clippy::has_significant_drop] that could be early dropped but are in fact dropped at the end of their scopes
- single_option_map`fn` that only maps over argument
- suboptimal_flopsexponent for bases 2 and e can be computed more accurately
- suspicious_operation_groupingsthis sequence of operators looks suspiciously like a bug
- too_long_first_doc_paragraphChecks if the first paragraph in the documentation of items listed in the module page is too long
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::redundant_cloneChecks for a redundant clone() (and its relatives) which clones an owned value that is going to be dropped without further useRead it next →Did this answer your question?