libfringe/src/lib.rs

60 lines
1.8 KiB
Rust
Raw Normal View History

2015-04-16 20:06:57 +08:00
// This file is part of libfringe, a low-level green threading library.
// Copyright (c) edef <edef@edef.eu>
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
#![feature(asm, naked_functions, cfg_target_vendor)]
2016-08-19 21:58:45 +08:00
#![cfg_attr(feature = "alloc", feature(alloc))]
#![cfg_attr(test, feature(test, thread_local, const_fn))]
#![no_std]
//! libfringe is a library implementing safe, lightweight context switches,
//! without relying on kernel services. It can be used in hosted environments
//! (using `std`) as well as on bare metal (using `core`).
//!
//! It provides the following safe abstractions:
//!
//! * an implementation of generators,
//! [Generator](generator/struct.Generator.html).
//!
//! It also provides the necessary low-level building blocks:
//!
//! * a trait that can be implemented by stack allocators,
//! [Stack](struct.Stack.html);
2016-08-19 21:58:45 +08:00
//! * a wrapper for using slice references as stacks,
//! [SliceStack](struct.SliceStack.html);
//! * a stack allocator based on `Box<[u8]>`,
//! [OwnedStack](struct.OwnedStack.html);
//! * a stack allocator based on anonymous memory mappings with guard pages,
//! [OsStack](struct.OsStack.html).
#[cfg(test)]
#[macro_use]
extern crate std;
2015-04-16 22:12:26 +08:00
pub use stack::Stack;
pub use stack::GuardedStack;
2016-08-19 21:58:45 +08:00
pub use slice_stack::SliceStack;
pub use generator::Generator;
2015-04-16 19:45:14 +08:00
2016-08-19 21:58:45 +08:00
#[cfg(feature = "alloc")]
pub use owned_stack::OwnedStack;
#[cfg(unix)]
pub use os::Stack as OsStack;
2014-12-23 11:24:40 +08:00
mod arch;
mod debug;
mod context;
2016-08-19 21:58:45 +08:00
mod stack;
mod slice_stack;
pub mod generator;
2016-08-19 21:58:45 +08:00
#[cfg(feature = "alloc")]
mod owned_stack;
#[cfg(unix)]
2015-04-16 19:45:14 +08:00
mod os;