      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
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262

    // Copyright 2012-2015 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.

    //! Crate docs

    #![allow(bad_style, overflowing_literals, improper_ctypes)]
    #![crate_type = "rlib"]
    #![crate_name = "libc"]
    #![cfg_attr(dox, feature(no_core, lang_items))]
    #![cfg_attr(dox, no_core)]
    #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
           html_favicon_url = "../../rust-logo-32x32-blk.png")]

    #![cfg_attr(all(target_os = "linux", target_arch = "x86_64"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-linux-gnu"
    ))]
    #![cfg_attr(all(target_os = "linux", target_arch = "x86"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/i686-unknown-linux-gnu"
    ))]
    #![cfg_attr(all(target_os = "linux", target_arch = "arm"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/arm-unknown-linux-gnueabihf"
    ))]
    #![cfg_attr(all(target_os = "linux", target_arch = "mips"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/mips-unknown-linux-gnu"
    ))]
    #![cfg_attr(all(target_os = "linux", target_arch = "aarch64"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/aarch64-unknown-linux-gnu"
    ))]
    #![cfg_attr(all(target_os = "linux", target_env = "musl"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-linux-musl"
    ))]
    #![cfg_attr(all(target_os = "macos", target_arch = "x86_64"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-apple-darwin"
    ))]
    #![cfg_attr(all(target_os = "macos", target_arch = "x86"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/i686-apple-darwin"
    ))]
    #![cfg_attr(all(windows, target_arch = "x86_64", target_env = "gnu"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-pc-windows-gnu"
    ))]
    #![cfg_attr(all(windows, target_arch = "x86", target_env = "gnu"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/i686-pc-windows-gnu"
    ))]
    #![cfg_attr(all(windows, target_arch = "x86_64", target_env = "msvc"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-pc-windows-msvc"
    ))]
    #![cfg_attr(all(windows, target_arch = "x86", target_env = "msvc"), doc(
        html_root_url = "https://doc.rust-lang.org/libc/i686-pc-windows-msvc"
    ))]
    #![cfg_attr(target_os = "android", doc(
        html_root_url = "https://doc.rust-lang.org/libc/arm-linux-androideabi"
    ))]
    #![cfg_attr(target_os = "freebsd", doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-freebsd"
    ))]
    #![cfg_attr(target_os = "openbsd", doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-openbsd"
    ))]
    #![cfg_attr(target_os = "bitrig", doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-bitrig"
    ))]
    #![cfg_attr(target_os = "netbsd", doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-netbsd"
    ))]
    #![cfg_attr(target_os = "dragonfly", doc(
        html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-dragonfly"
    ))]

    // Attributes needed when building as part of the standard library
    #![cfg_attr(stdbuild, feature(no_std, core, core_slice_ext, staged_api, custom_attribute))]
    #![cfg_attr(stdbuild, no_std)]
    #![cfg_attr(stdbuild, staged_api)]
    #![cfg_attr(stdbuild, allow(warnings))]
    #![cfg_attr(stdbuild, unstable(feature = "libc",
                                   reason = "use `libc` from crates.io",
                                   issue = "27783"))]

    #[cfg(all(not(stdbuild), not(dox)))]
    extern crate std as core;

    #[macro_use] mod macros;
    mod dox;

    // Use repr(u8) as LLVM expects `void*` to be the same as `i8*` to help enable
    // more optimization opportunities around it recognizing things like
    // malloc/free.
    #[repr(u8)]
    pub enum c_void {
        // Two dummy variants so the #[repr] attribute can be used.
        #[doc(hidden)]
        __variant1,
        #[doc(hidden)]
        __variant2,
    }

    pub type int8_t = i8;
    pub type int16_t = i16;
    pub type int32_t = i32;
    pub type int64_t = i64;
    pub type uint8_t = u8;
    pub type uint16_t = u16;
    pub type uint32_t = u32;
    pub type uint64_t = u64;

    pub type c_schar = i8;
    pub type c_uchar = u8;
    pub type c_short = i16;
    pub type c_ushort = u16;
    pub type c_int = i32;
    pub type c_uint = u32;
    pub type c_float = f32;
    pub type c_double = f64;
    pub type c_longlong = i64;
    pub type c_ulonglong = u64;
    pub type intmax_t = i64;
    pub type uintmax_t = u64;

    pub type size_t = usize;
    pub type ptrdiff_t = isize;
    pub type intptr_t = isize;
    pub type uintptr_t = usize;
    pub type ssize_t = isize;

    pub enum FILE {}
    pub enum fpos_t {} // TODO: fill this out with a struct

    extern {
        pub fn isalnum(c: c_int) -> c_int;
        pub fn isalpha(c: c_int) -> c_int;
        pub fn iscntrl(c: c_int) -> c_int;
        pub fn isdigit(c: c_int) -> c_int;
        pub fn isgraph(c: c_int) -> c_int;
        pub fn islower(c: c_int) -> c_int;
        pub fn isprint(c: c_int) -> c_int;
        pub fn ispunct(c: c_int) -> c_int;
        pub fn isspace(c: c_int) -> c_int;
        pub fn isupper(c: c_int) -> c_int;
        pub fn isxdigit(c: c_int) -> c_int;
        pub fn tolower(c: c_int) -> c_int;
        pub fn toupper(c: c_int) -> c_int;

        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "fopen$UNIX2003")]
        pub fn fopen(filename: *const c_char,
                     mode: *const c_char) -> *mut FILE;
        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "freopen$UNIX2003")]
        pub fn freopen(filename: *const c_char, mode: *const c_char,
                       file: *mut FILE) -> *mut FILE;
        pub fn fflush(file: *mut FILE) -> c_int;
        pub fn fclose(file: *mut FILE) -> c_int;
        pub fn remove(filename: *const c_char) -> c_int;
        pub fn rename(oldname: *const c_char, newname: *const c_char) -> c_int;
        pub fn tmpfile() -> *mut FILE;
        pub fn setvbuf(stream: *mut FILE,
                       buffer: *mut c_char,
                       mode: c_int,
                       size: size_t) -> c_int;
        pub fn setbuf(stream: *mut FILE, buf: *mut c_char);
        pub fn fgetc(stream: *mut FILE) -> c_int;
        pub fn fgets(buf: *mut c_char, n: c_int, stream: *mut FILE) -> *mut c_char;
        pub fn fputc(c: c_int, stream: *mut FILE) -> c_int;
        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "fputs$UNIX2003")]
        pub fn fputs(s: *const c_char, stream: *mut FILE)-> c_int;
        pub fn puts(s: *const c_char) -> c_int;
        pub fn ungetc(c: c_int, stream: *mut FILE) -> c_int;
        pub fn fread(ptr: *mut c_void,
                     size: size_t,
                     nobj: size_t,
                     stream: *mut FILE)
                     -> size_t;
        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "fwrite$UNIX2003")]
        pub fn fwrite(ptr: *const c_void,
                      size: size_t,
                      nobj: size_t,
                      stream: *mut FILE)
                      -> size_t;
        pub fn fseek(stream: *mut FILE, offset: c_long, whence: c_int) -> c_int;
        pub fn ftell(stream: *mut FILE) -> c_long;
        pub fn rewind(stream: *mut FILE);
        #[cfg_attr(target_os = "netbsd", link_name = "__fgetpos50")]
        pub fn fgetpos(stream: *mut FILE, ptr: *mut fpos_t) -> c_int;
        #[cfg_attr(target_os = "netbsd", link_name = "__fsetpos50")]
        pub fn fsetpos(stream: *mut FILE, ptr: *const fpos_t) -> c_int;
        pub fn feof(stream: *mut FILE) -> c_int;
        pub fn ferror(stream: *mut FILE) -> c_int;
        pub fn perror(s: *const c_char);
        pub fn atoi(s: *const c_char) -> c_int;
        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "strtod$UNIX2003")]
        pub fn strtod(s: *const c_char, endp: *mut *mut c_char) -> c_double;
        pub fn strtol(s: *const c_char,
                      endp: *mut *mut c_char, base: c_int) -> c_long;
        pub fn strtoul(s: *const c_char, endp: *mut *mut c_char,
                       base: c_int) -> c_ulong;
        pub fn calloc(nobj: size_t, size: size_t) -> *mut c_void;
        pub fn malloc(size: size_t) -> *mut c_void;
        pub fn realloc(p: *mut c_void, size: size_t) -> *mut c_void;
        pub fn free(p: *mut c_void);
        pub fn exit(status: c_int) -> !;
        pub fn _exit(status: c_int) -> !;
        pub fn atexit(cb: extern fn()) -> c_int;
        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "system$UNIX2003")]
        pub fn system(s: *const c_char) -> c_int;
        pub fn getenv(s: *const c_char) -> *mut c_char;

        pub fn strcpy(dst: *mut c_char, src: *const c_char) -> *mut c_char;
        pub fn strncpy(dst: *mut c_char, src: *const c_char, n: size_t)
                       -> *mut c_char;
        pub fn strcat(s: *mut c_char, ct: *const c_char) -> *mut c_char;
        pub fn strncat(s: *mut c_char, ct: *const c_char, n: size_t) -> *mut c_char;
        pub fn strcmp(cs: *const c_char, ct: *const c_char) -> c_int;
        pub fn strncmp(cs: *const c_char, ct: *const c_char, n: size_t) -> c_int;
        pub fn strcoll(cs: *const c_char, ct: *const c_char) -> c_int;
        pub fn strchr(cs: *const c_char, c: c_int) -> *mut c_char;
        pub fn strrchr(cs: *const c_char, c: c_int) -> *mut c_char;
        pub fn strspn(cs: *const c_char, ct: *const c_char) -> size_t;
        pub fn strcspn(cs: *const c_char, ct: *const c_char) -> size_t;
        pub fn strpbrk(cs: *const c_char, ct: *const c_char) -> *mut c_char;
        pub fn strstr(cs: *const c_char, ct: *const c_char) -> *mut c_char;
        pub fn strlen(cs: *const c_char) -> size_t;
        #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
                   link_name = "strerror$UNIX2003")]
        pub fn strerror(n: c_int) -> *mut c_char;
        pub fn strtok(s: *mut c_char, t: *const c_char) -> *mut c_char;
        pub fn strxfrm(s: *mut c_char, ct: *const c_char, n: size_t) -> size_t;
        pub fn wcslen(buf: *const wchar_t) -> size_t;

        pub fn memcmp(cx: *const c_void, ct: *const c_void, n: size_t) -> c_int;
        pub fn memchr(cx: *const c_void, c: c_int, n: size_t) -> *mut c_void;
    }

    // These are all inline functions on android, so they end up just being entirely
    // missing on that platform.
    #[cfg(not(target_os = "android"))]
    extern {
        pub fn abs(i: c_int) -> c_int;
        pub fn atof(s: *const c_char) -> c_double;
        pub fn labs(i: c_long) -> c_long;
        pub fn rand() -> c_int;
        pub fn srand(seed: c_uint);
    }

    cfg_if! {
        if #[cfg(windows)] {
            mod windows;
            pub use windows::*;
        } else {
            mod unix;
            pub use unix::*;
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## 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`)