ghosts 0.1.0

Type-check non-existing `Phantom` code for Fun And Profit™.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

#![doc = include_str!("../README.md")]
#![cfg_attr(feature = "better-docs", feature(
    doc_cfg, rustdoc_internals,
))]
#![doc(html_logo_url = "https://user-images.githubusercontent.com/9920355/166294360-9ee4ec3d-685c-49e5-b006-1e9077f8cc01.png")]
#![deny(rustdoc::private_intra_doc_links)]

#![no_std]
#![forbid(unsafe_code)]
#![allow(uncommon_codepoints)]

/// The crate's _haunted_ prelude.
pub
mod vestibule {
    #[doc(no_inline)]
    pub use {
        crate::{
            Ectoplasm,
            ectoplasm,
            Ghost,
            ghost,
            materialize_return,
            // materialize,
        },
    };
}

#[cfg_attr(feature = "better-docs",
    doc(cfg(ghostǃ)),
    doc(keyword = "no_init"),
)]
/// Use `#[no_init]` inside a [`ghost!`] block to opt out of consuming
/// ownership of outside captures.
///
/**  - ```rust
    use ::ghosts::vestibule::*;

    let owned = String::from("…");
    let casper = ghost!(#[no_init] {
        owned
    });
    drop(owned); // OK
    ``` */
mod ghost_no_init {}

#[cfg_attr(feature = "better-docs",
    doc(cfg(ghostǃ)),
    doc(keyword = "no_dropck"),
)]
/// Use `#[no_dropck]` inside a [`ghost!`] block to opt out of all the move
/// semantics altogether inside a `ghost!` block (it thus implies `#[no_init]`).
///
/**  - ```rust
    use ::ghosts::vestibule::*;

    let owned = String::from("…");
    let casper = ghost!(#[no_dropck] {
        drop(owned);
        drop(owned); // OK, move semantics are no longer involved.
    });
    drop(owned); // OK as well: `no_dropck` "implies `no_init`".
    ``` */
mod ghost_no_dropck {}

#[cfg_attr(feature = "better-docs",
    doc(cfg(ghostǃ)),
    doc(keyword = "tag"),
)]
/// Use `#[tag]` to accept **and discard** extra attribute metadata.
///
/// May be useful for [tool attributes](
/// https://doc.rust-lang.org/1.60.0/reference/attributes.html#tool-attributes).
///
/**  - ```rust
    use ::ghosts::vestibule::*;

    let casper = ghost!(#[tag(my_tool::my_annotation)] {
        drop("this is fine");
    });
    ``` */
mod ghost_tag {}

pub use expr::*;
mod expr;

// We use this rather than a module so that the methods do show up on docs.rs
// include!("ty/fns.rs");

// macro internals
#[doc(hidden)] /** Not part of the public API */ pub
mod ඞ {
    pub use {
        ::core, // or `std`
        ::ghosts_proc_macros::{
            *,
        },
        crate::{
            expr::flatten::Flatten,
        },
    };
    pub use crate::ty::ghost::Ghost;
}

#[cfg_attr(feature = "ui-tests",
    cfg_attr(all(), doc = include_str!("compile_fail_tests.md")),
)]
mod _compile_fail_tests {}

#[doc(inline)]
pub use ty::Ghost;
mod ty;