mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

std: Expand doc comments for time module

Browse Source
This commit is contained in:
Chris Peterson 2012-02-18 01:27:10 -08:00
parent 123a920f59
commit 105b5f0be8
1 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/libstd/time.rs
View File

@ -2,18 +2,25 @@
Module: time
*/
// FIXME: Document what these functions do
#[abi = "cdecl"]
native mod rustrt {
fn get_time(&sec: u32, &usec: u32);
fn nano_time(&ns: u64);
}
/* Type: timeval */
/*
Type: timeval
A record specifying a time value in seconds and microseconds.
*/
type timeval = {sec: u32, usec: u32};
/* Function: get_time */
/*
Function: get_time
Returns the current time as a `timeval` containing the seconds and
microseconds since 1970-01-01T00:00:00Z.
*/
fn get_time() -> timeval {
let sec = 0u32;
let usec = 0u32;
@ -21,10 +28,20 @@ fn get_time() -> timeval {
ret {sec: sec, usec: usec};
}
/* Function: precise_time_ns */
/*
Function: precise_time_ns
Returns the current value of a high-resolution performance counter
in nanoseconds since an unspecified epoch.
*/
fn precise_time_ns() -> u64 { let ns = 0u64; rustrt::nano_time(ns); ret ns; }
/* Function: precise_time_s */
/*
Function: precise_time_s
Returns the current value of a high-resolution performance counter
in seconds since an unspecified epoch.
*/
fn precise_time_s() -> float {
ret (precise_time_ns() as float) / 1000000000.;
}