document Stack and StackSource

This commit is contained in:
edef 2015-04-15 23:37:17 -04:00
parent 5b6aa23731
commit 5c252bdef5

View File

@ -1,8 +1,18 @@
//! Traits for stacks.
/// A trait for objects that hold ownership of a stack.
pub trait Stack {
/// Returns the top of the stack.
/// On all modern architectures, the stack grows downwards,
/// so this is the highest address.
fn top(&mut self) -> *mut u8;
/// Returns the bottom of the stack.
/// On all modern architectures, the stack grows downwards,
/// so this is the lowest address.
fn limit(&self) -> *const u8;
}
/// A trait for objects that provide stacks of arbitrary size.
pub trait StackSource {
type Output: Stack;
fn get_stack(size: usize) -> Self::Output;