summaryrefslogtreecommitdiffstats
path: root/compiler/rustc_error_codes/src/error_codes/E0446.md
blob: 6ec47c4962c06fc50414a955175a039b6ab2f604 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
A private type was used in a public type signature.

Erroneous code example:

```compile_fail,E0446
#![deny(private_in_public)]
struct Bar(u32);

mod foo {
    use crate::Bar;
    pub fn bar() -> Bar { // error: private type in public interface
        Bar(0)
    }
}

fn main() {}
```

There are two ways to solve this error. The first is to make the public type
signature only public to a module that also has access to the private type.
This is done by using pub(crate) or pub(in crate::my_mod::etc)
Example:

```
struct Bar(u32);

mod foo {
    use crate::Bar;
    pub(crate) fn bar() -> Bar { // only public to crate root
        Bar(0)
    }
}

fn main() {}
```

The other way to solve this error is to make the private type public.
Example:

```
pub struct Bar(u32); // we set the Bar type public
mod foo {
    use crate::Bar;
    pub fn bar() -> Bar { // ok!
        Bar(0)
    }
}

fn main() {}
```