mod.rs.html -- source
Description: Source to the Rust file `libstd/sys_common/mod.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141

    // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.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.

    //! Platform-independent platform abstraction
    //!
    //! This is the platform-independent portion of the standard library's
    //! platform abstraction layer, whereas `std::sys` is the
    //! platform-specific portion.
    //!
    //! The relationship between `std::sys_common`, `std::sys` and the
    //! rest of `std` is complex, with dependencies going in all
    //! directions: `std` depending on `sys_common`, `sys_common`
    //! depending on `sys`, and `sys` depending on `sys_common` and `std`.
    //! Ideally `sys_common` would be split into two and the dependencies
    //! between them all would form a dag, facilitating the extraction of
    //! `std::sys` from the standard library.

    #![allow(missing_docs)]
    #![allow(missing_debug_implementations)]

    use sync::Once;
    use sys;

    macro_rules! rtabort {
        ($($t:tt)*) => (::sys_common::util::abort(format_args!($($t)*)))
    }

    macro_rules! rtassert {
        ($e:expr) => (if !$e {
            rtabort!(concat!("assertion failed: ", stringify!($e)));
        })
    }

    pub mod at_exit_imp;
    #[cfg(feature = "backtrace")]
    pub mod backtrace;
    pub mod condvar;
    pub mod io;
    pub mod mutex;
    pub mod poison;
    pub mod remutex;
    pub mod rwlock;
    pub mod thread;
    pub mod thread_info;
    pub mod thread_local;
    pub mod util;
    pub mod wtf8;
    pub mod bytestring;
    pub mod process;

    cfg_if! {
        if #[cfg(any(target_os = "cloudabi", target_os = "l4re", target_os = "redox"))] {
            pub use sys::net;
        } else if #[cfg(all(target_arch = "wasm32", not(target_os = "emscripten")))] {
            pub use sys::net;
        } else {
            pub mod net;
        }
    }

    #[cfg(feature = "backtrace")]
    #[cfg(any(all(unix, not(target_os = "emscripten")),
              all(windows, target_env = "gnu"),
              target_os = "redox"))]
    pub mod gnu;

    // common error constructors

    /// A trait for viewing representations from std types
    #[doc(hidden)]
    pub trait AsInner<Inner: ?Sized> {
        fn as_inner(&self) -> &Inner;
    }

    /// A trait for viewing representations from std types
    #[doc(hidden)]
    pub trait AsInnerMut<Inner: ?Sized> {
        fn as_inner_mut(&mut self) -> &mut Inner;
    }

    /// A trait for extracting representations from std types
    #[doc(hidden)]
    pub trait IntoInner<Inner> {
        fn into_inner(self) -> Inner;
    }

    /// A trait for creating std types from internal representations
    #[doc(hidden)]
    pub trait FromInner<Inner> {
        fn from_inner(inner: Inner) -> Self;
    }

    /// Enqueues a procedure to run when the main thread exits.
    ///
    /// Currently these closures are only run once the main *Rust* thread exits.
    /// Once the `at_exit` handlers begin running, more may be enqueued, but not
    /// infinitely so. Eventually a handler registration will be forced to fail.
    ///
    /// Returns `Ok` if the handler was successfully registered, meaning that the
    /// closure will be run once the main thread exits. Returns `Err` to indicate
    /// that the closure could not be registered, meaning that it is not scheduled
    /// to be run.
    pub fn at_exit<F: FnOnce() + Send + 'static>(f: F) -> Result<(), ()> {
        if at_exit_imp::push(Box::new(f)) {Ok(())} else {Err(())}
    }

    /// One-time runtime cleanup.
    pub fn cleanup() {
        static CLEANUP: Once = Once::new();
        CLEANUP.call_once(|| unsafe {
            sys::args::cleanup();
            sys::stack_overflow::cleanup();
            at_exit_imp::cleanup();
        });
    }

    // Computes (value*numer)/denom without overflow, as long as both
    // (numer*denom) and the overall result fit into i64 (which is the case
    // for our time conversions).
    #[allow(dead_code)] // not used on all platforms
    pub fn mul_div_u64(value: u64, numer: u64, denom: u64) -> u64 {
        let q = value / denom;
        let r = value % denom;
        // Decompose value as (value/denom*denom + value%denom),
        // substitute into (value*numer)/denom and simplify.
        // r < denom, so (denom*numer) is the upper bound of (r*numer)
        q * numer + r * numer / denom
    }

    #[test]
    fn test_muldiv() {
        assert_eq!(mul_div_u64( 1_000_000_000_001, 1_000_000_000, 1_000_000),
                   1_000_000_000_001_000);
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)