pub_source 0.1.2

Make everything public
Documentation 
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# `pub_source` - Make Everything Public

<p align="center">
    <img src="branding/logo_embedded_font.svg" alt="pub_source logo" />
</p>
<p align="center">
        <a href="https://crates.io/crates/pub_source"><img alt="crates.io version" src="https://img.shields.io/crates/v/pub_source" /></a>
        <a href="./LICENSE"><img alt="License" src="https://img.shields.io/crates/l/pub_source" /></a>
        <a href="https://GitHub.com/TabulateJarl8/pub_source/issues/"><img alt="GitHub Issues" src="https://img.shields.io/github/issues/TabulateJarl8/pub_source" /></a>
        <a href="https://docs.rs/pub_source"><img alt="docs.rs build status" src="https://img.shields.io/docsrs/pub_source" /></a>
        <a href="https://github.com/TabulateJarl8/pub_source/actions/workflows/test.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/TabulateJarl8/pub_source/test.yml?label=tests" /></a>
</p>

`pub_source` provides the `make_public!` procedural macro, which rewrites a block of Rust source code so that all top level items become public.

This macro parses the input as a full `syn::File` and rewrites the following kinds of items to `pub`:

- functions
- structs and all of their fields
- enums
- type aliases
- constants and statics
- traits
- modules (recursively)
- impl blocks (functions, consts, type items inside them)
- unions

Non-items such as `use`, macros, or foreign modules are left unchanged.

This crate also denies the use of `unwrap`, `expect`, and `panic!()`.

## Usage

```sh
cargo add pub_source
```

Then the crate can be used as follows:

```rust
pub_source::make_public! {
    fn hidden() {}

    struct Thing {
        a: u32,
        b: String,
    }

    impl Thing {
        fn show(&self) {
            println!("{}", self.b);
        }
    }
}
```

Expands to code equivalent to:

```rust
pub fn hidden() {}

pub struct Thing {
    pub a: u32,
    pub b: String,
}

impl Thing {
    pub fn show(&self) {
        println!("{}", self.b);
    }
}
```

This was originally written to be injected around user-submitted code in a code runner so that unit tests could access everything the user wrote. There may be other uses but I'm not quite sure what they might be yet.

## Feature Flags

This crate provides two feature flags:

- `std` - used for enabling stdlib support, enabled by default
- `unstable` - used for enabling unstable features (trait aliases, impl-associated types) on nightly compilers that are using these features

## License

This crate is licensed under the MIT license