Clippy lint · Nursery · checked with Clippy 0.1.99

clippy::redundant_pub_crate: pub(crate) function inside private module

What it meansChecks for items declared pub(crate) that are not crate visible because they are inside a private module. It is in the nursery group and off by default.

What you see

warning: pub(crate) function inside private module
 --> main.rs:4:5
  |
4 |     pub(crate) fn internal_fn() { }
  |     ----------^^^^^^^^^^^^^^^
  |     |
  |     help: consider using: `pub`
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#redundant_pub_crate
  = note: `-W clippy::redundant-pub-crate` implied by `-W clippy::nursery`

Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.

Does it matter?

Writing pub(crate) is misleading when it’s redundant due to the parent module’s visibility.

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

mod internal {
    pub(crate) fn internal_fn() { }
}

Write this instead

mod internal {
    pub fn internal_fn() { }
}

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]
redundant_pub_crate = "warn"

In code

#![warn(clippy::redundant_pub_crate)]

One run

cargo clippy -- -W clippy::redundant-pub-crate

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.

Nurserygroup

allowdefault level

yesfixed by cargo clippy --fix

1.44.0added in Rust

Clippy's own documentation

What it does

Checks for items declared pub(crate) that are not crate visible because they are inside a private module.

Why is this bad?

Writing pub(crate) is misleading when it’s redundant due to the parent module’s visibility.

Example

mod internal {
    pub(crate) fn internal_fn() { }
}

This function is not visible outside the module and it can be declared with pub or private visibility

mod internal {
    pub fn internal_fn() { }
}

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?