libfringe/src/lib.rs

46 lines
1.3 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>
2015-04-16 18:08:44 +08:00
// See the LICENSE file included in this distribution.
#![feature(asm)]
#![cfg_attr(test, feature(test, thread_local, const_fn))]
#![cfg_attr(target_arch = "x86", feature(naked_functions, core_intrinsics))]
#![cfg_attr(target_arch = "x86_64", feature(naked_functions, core_intrinsics))]
#![no_std]
//! libfringe is a library implementing 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 high-level, safe abstractions:
//!
//! * an implementation of internal iterators, also known as generators,
//! [Generator](generator/struct.Generator.html).
//!
2016-08-09 22:10:30 +08:00
//! It also provides low-level, unsafe building blocks:
//!
//! * a trait that can be implemented by stack allocators,
//! [Stack](struct.Stack.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;
pub use generator::Generator;
2015-04-16 19:45:14 +08:00
#[cfg(any(unix, windows))]
pub use os::Stack as OsStack;
2014-12-23 11:24:40 +08:00
mod arch;
mod debug;
mod stack;
mod context;
pub mod generator;
#[cfg(any(unix, windows))]
2015-04-16 19:45:14 +08:00
mod os;