diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
commit | 698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch) | |
tree | 173a775858bd501c378080a10dca74132f05bc50 /vendor/stacker/README.md | |
parent | Initial commit. (diff) | |
download | rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip |
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/stacker/README.md')
-rw-r--r-- | vendor/stacker/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/vendor/stacker/README.md b/vendor/stacker/README.md new file mode 100644 index 000000000..c8d39a6f6 --- /dev/null +++ b/vendor/stacker/README.md @@ -0,0 +1,44 @@ +# stacker + +[![Build Status](https://github.com/rust-lang/stacker/workflows/Test%20stacker/badge.svg)](https://github.com/rust-lang/stacker/actions) + +[Documentation](https://docs.rs/stacker) + +A stack-growth library for Rust. Enables annotating fixed points in programs +where the stack may want to grow larger. Spills over to the heap if the stack +has hit its limit. + +This library is intended on helping implement recursive algorithms. + +```toml +# Cargo.toml +[dependencies] +stacker = "0.1" +``` + +## Platform Support + +This library currently uses psm for its cross platform capabilities, with a notable exception of +Windows, which uses an implementation based on Fibers. See the README for psm for the support +table. + +On all unsupported platforms this library is a noop. It should compile and run, but it +won't actually grow the stack and code will continue to hit the guard pages +typically in place. + +# License + +This project is licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this project by you, as defined in the Apache-2.0 license, +shall be dual licensed as above, without any additional terms or conditions. |