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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

/*
 * Copyright 2022 taylor.fish <contact@taylor.fish>
 *
 * This file is part of allocator-fallback.
 *
 * allocator-fallback is licensed under the Apache License, Version 2.0
 * (the "License"); you may not use allocator-fallback except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#![cfg_attr(not(any(feature = "std", doc)), no_std)]
#![cfg_attr(feature = "allocator_api", feature(allocator_api))]
#![cfg_attr(feature = "doc_cfg", feature(doc_cfg))]
#![deny(unsafe_op_in_unsafe_fn)]

//! This crate provides a minimal fallback for the standard library’s allocator
//! API, which is currently unstable.
//!
//! Usage
//! -----
//!
//! Because allocator-fallback can be configured to re-export the real
//! unstable allocator API (see [Crate features](#crate-features)), users
//! of this crate must make sure they conditionally enable
//! `#![feature(allocator_api)]` in preparation for this occurrence; otherwise,
//! compilation errors may occur. This is the case even for crates that never
//! directly enable allocator-fallback’s `allocator_api` feature, because a
//! different crate that also depends on allocator-fallback could enable it.
//!
//! To accomplish this, in `Cargo.toml`, duplicate your dependency on
//! `allocator-fallback` in the `[build-dependencies]` section. For example:
//!
//! ```toml
//! [dependencies]
//! allocator-fallback = "0.1.7"
//!
//! [build-dependencies]
//! allocator-fallback = "0.1.7"
//! ```
//!
//! Then, add a [build script][build] (`build.rs`) with the following
//! contents:[^1]
//!
//! [build]: https://doc.rust-lang.org/cargo/reference/build-scripts.html
//!
//! ```rust
//! fn main() {
//!    if allocator_fallback::HAS_ALLOCATOR_API {
//!        println!("cargo:rustc-cfg=has_allocator_api");
//!    }
//! }
//! ```
//!
//! Finally, at the top of your crate root (likely `lib.rs` or `main.rs`), add
//! the following:
//!
//! ```rust
//! #![cfg_attr(has_allocator_api, feature(allocator_api))]
//! ```
//!
//! ### Use as an optional dependency
//!
//! The instructions above will not work if `allocator-fallback` is declared
//! as an optional dependency. In this case, adjust the instructions as
//! follows:
//!
//! Duplicate the dependency on `allocator-fallback` in `[build-dependencies]`
//! as before, keeping `optional = true` in both occurrences. For example:
//!
//! ```toml
//! [dependencies.allocator-fallback]
//! version = "0.1.7"
//! optional = true
//!
//! [build-dependencies.allocator-fallback]
//! version = "0.1.7"
//! optional = true
//! ```
//!
//! Then, use the following as the contents of your build script (`build.rs`)
//! instead:[^1]
//!
//! ```rust
//! fn main() {
//!    #[cfg(feature = "allocator-fallback")]
//!    if allocator_fallback::HAS_ALLOCATOR_API {
//!        println!("cargo:rustc-cfg=has_allocator_api");
//!    }
//! }
//! ```
//!
//! Finally, as before, add the following to the top of your crate root:
//!
//! ```rust
//! #![cfg_attr(has_allocator_api, feature(allocator_api))]
//! ```
//!
//! [^1]: These build script code snippets have been released to the public
//!       domain using the [CC0 1.0 Universal Public Domain Dedication][CC0].
//!
//! [CC0]: https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt
//!
//! Crate features
//! --------------
//!
//! If the crate feature `allocator_api` is enabled, this crate will simply
//! re-export the real allocator API in the standard library. Of course, this
//! requires Rust nightly.
//!
//! If the crate feature `std` is enabled (the default), the crate will use
//! [`std`]; otherwise, it will be `no_std`. Using [`std`] allows
//! [`AllocError`] to implement [`std::error::Error`].

extern crate alloc;

#[cfg(not(feature = "allocator_api"))]
mod fallback;

#[cfg(not(feature = "allocator_api"))]
pub use fallback::{AllocError, Allocator, Global};

#[cfg(feature = "allocator_api")]
pub use alloc::alloc::{AllocError, Allocator, Global};

/// For use in build scripts. See [Usage](crate#usage).
pub const HAS_ALLOCATOR_API: bool = cfg!(has_allocator_api);

#[test]
fn test() {
    use alloc::alloc::Layout;
    let _: &dyn Allocator = &Global;
    let ptr = Global.allocate(Layout::new::<u64>()).unwrap();
    unsafe {
        ptr.cast::<u64>().as_ptr().write(0x123456789abcdef);
        (&&&Global).deallocate(ptr.cast(), Layout::new::<u64>());
    }
}