      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

    /// A macro for defining #[cfg] if-else statements.
    ///
    /// This is similar to the `if/elif` C preprocessor macro by allowing definition
    /// of a cascade of `#[cfg]` cases, emitting the implementation which matches
    /// first.
    ///
    /// This allows you to conveniently provide a long list #[cfg]'d blocks of code
    /// without having to rewrite each clause multiple times.
    #[allow(unused_macros)]
    macro_rules! cfg_if {
        // match if/else chains with a final `else`
        ($(
            if #[cfg($($meta:meta),*)] { $($it:item)* }
        ) else * else {
            $($it2:item)*
        }) => {
            cfg_if! {
                @__items
                () ;
                $( ( ($($meta),*) ($($it)*) ), )*
                ( () ($($it2)*) ),
            }
        };

        // match if/else chains lacking a final `else`
        (
            if #[cfg($($i_met:meta),*)] { $($i_it:item)* }
            $(
                else if #[cfg($($e_met:meta),*)] { $($e_it:item)* }
            )*
        ) => {
            cfg_if! {
                @__items
                () ;
                ( ($($i_met),*) ($($i_it)*) ),
                $( ( ($($e_met),*) ($($e_it)*) ), )*
                ( () () ),
            }
        };

        // Internal and recursive macro to emit all the items
        //
        // Collects all the negated cfgs in a list at the beginning and after the
        // semicolon is all the remaining items
        (@__items ($($not:meta,)*) ; ) => {};
        (@__items ($($not:meta,)*) ; ( ($($m:meta),*) ($($it:item)*) ),
         $($rest:tt)*) => {
            // Emit all items within one block, applying an approprate #[cfg]. The
            // #[cfg] will require all `$m` matchers specified and must also negate
            // all previous matchers.
            cfg_if! { @__apply cfg(all($($m,)* not(any($($not),*)))), $($it)* }

            // Recurse to emit all other items in `$rest`, and when we do so add all
            // our `$m` matchers to the list of `$not` matchers as future emissions
            // will have to negate everything we just matched as well.
            cfg_if! { @__items ($($not,)* $($m,)*) ; $($rest)* }
        };

        // Internal macro to Apply a cfg attribute to a list of items
        (@__apply $m:meta, $($it:item)*) => {
            $(#[$m] $it)*
        };
    }

    #[allow(unused_macros)]
    macro_rules! s {
        ($($(#[$attr:meta])* pub $t:ident $i:ident { $($field:tt)* })*) => ($(
            s!(it: $(#[$attr])* pub $t $i { $($field)* });
        )*);
        (it: $(#[$attr:meta])* pub union $i:ident { $($field:tt)* }) => (
            compile_error!("unions cannot derive extra traits, use s_no_extra_traits instead");
        );
        (it: $(#[$attr:meta])* pub struct $i:ident { $($field:tt)* }) => (
            __item! {
                #[repr(C)]
                #[cfg_attr(feature = "extra_traits", derive(Debug, Eq, Hash, PartialEq))]
                #[allow(deprecated)]
                $(#[$attr])*
                pub struct $i { $($field)* }
            }
            #[allow(deprecated)]
            impl ::Copy for $i {}
            #[allow(deprecated)]
            impl ::Clone for $i {
                fn clone(&self) -> $i { *self }
            }
        );
    }

    #[allow(unused_macros)]
    macro_rules! s_no_extra_traits {
        ($($(#[$attr:meta])* pub $t:ident $i:ident { $($field:tt)* })*) => ($(
            s_no_extra_traits!(it: $(#[$attr])* pub $t $i { $($field)* });
        )*);
        (it: $(#[$attr:meta])* pub union $i:ident { $($field:tt)* }) => (
            cfg_if! {
                if #[cfg(libc_union)] {
                    __item! {
                        #[repr(C)]
                        $(#[$attr])*
                        pub union $i { $($field)* }
                    }

                    impl ::Copy for $i {}
                    impl ::Clone for $i {
                        fn clone(&self) -> $i { *self }
                    }
                }
            }
        );
        (it: $(#[$attr:meta])* pub struct $i:ident { $($field:tt)* }) => (
            __item! {
                #[repr(C)]
                $(#[$attr])*
                pub struct $i { $($field)* }
            }
            impl ::Copy for $i {}
            impl ::Clone for $i {
                fn clone(&self) -> $i { *self }
            }
        );
    }

    #[allow(unused_macros)]
    macro_rules! f {
        ($(pub fn $i:ident($($arg:ident: $argty:ty),*) -> $ret:ty {
            $($body:stmt);*
        })*) => ($(
            #[inline]
            pub unsafe extern fn $i($($arg: $argty),*) -> $ret {
                $($body);*
            }
        )*)
    }

    #[allow(unused_macros)]
    macro_rules! __item {
        ($i:item) => {
            $i
        };
    }

    #[allow(unused_macros)]
    macro_rules! align_const {
        ($($(#[$attr:meta])*
           pub const $name:ident : $t1:ty
           = $t2:ident { $($field:tt)* };)*) => ($(
            #[cfg(libc_align)]
            $(#[$attr])*
            pub const $name : $t1 = $t2 {
                $($field)*
            };
            #[cfg(not(libc_align))]
            $(#[$attr])*
            pub const $name : $t1 = $t2 {
                $($field)*
                __align: [],
            };
        )*)
    }

    // This macro is used to deprecate items that should be accessed via the mach crate
    #[allow(unused_macros)]
    macro_rules! deprecated_mach {
        (pub const $id:ident: $ty:ty = $expr:expr;) => {
            #[deprecated(
                since = "0.2.55",
                note = "Use the `mach` crate instead",
            )]
            #[allow(deprecated)]
            pub const $id: $ty = $expr;
        };
        ($(pub const $id:ident: $ty:ty = $expr:expr;)*) => {
            $(
                deprecated_mach!(
                    pub const $id: $ty = $expr;
                );
            )*
        };
        (pub type $id:ident = $ty:ty;) => {
            #[deprecated(
                since = "0.2.55",
                note = "Use the `mach` crate instead",
            )]
            #[allow(deprecated)]
            pub type $id = $ty;
        };
        ($(pub type $id:ident = $ty:ty;)*) => {
            $(
                deprecated_mach!(
                    pub type $id = $ty;
                );
            )*
        }
    }

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