      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
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414

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

    //! A private parser implementation of IPv4, IPv6, and socket addresses.
    //!
    //! This module is "publicly exported" through the `FromStr` implementations
    //! below.

    use error::Error;
    use fmt;
    use net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6};
    use str::FromStr;

    struct Parser<'a> {
        // parsing as ASCII, so can use byte array
        s: &'a [u8],
        pos: usize,
    }

    impl<'a> Parser<'a> {
        fn new(s: &'a str) -> Parser<'a> {
            Parser {
                s: s.as_bytes(),
                pos: 0,
            }
        }

        fn is_eof(&self) -> bool {
            self.pos == self.s.len()
        }

        // Commit only if parser returns Some
        fn read_atomically<T, F>(&mut self, cb: F) -> Option<T> where
            F: FnOnce(&mut Parser) -> Option<T>,
        {
            let pos = self.pos;
            let r = cb(self);
            if r.is_none() {
                self.pos = pos;
            }
            r
        }

        // Commit only if parser read till EOF
        fn read_till_eof<T, F>(&mut self, cb: F) -> Option<T> where
            F: FnOnce(&mut Parser) -> Option<T>,
        {
            self.read_atomically(move |p| {
                cb(p).filter(|_| p.is_eof())
            })
        }

        // Return result of first successful parser
        fn read_or<T>(&mut self, parsers: &mut [Box<dyn FnMut(&mut Parser) -> Option<T> + 'static>])
                   -> Option<T> {
            for pf in parsers {
                if let Some(r) = self.read_atomically(|p: &mut Parser| pf(p)) {
                    return Some(r);
                }
            }
            None
        }

        // Apply 3 parsers sequentially
        fn read_seq_3<A, B, C, PA, PB, PC>(&mut self,
                                           pa: PA,
                                           pb: PB,
                                           pc: PC)
                                           -> Option<(A, B, C)> where
            PA: FnOnce(&mut Parser) -> Option<A>,
            PB: FnOnce(&mut Parser) -> Option<B>,
            PC: FnOnce(&mut Parser) -> Option<C>,
        {
            self.read_atomically(move |p| {
                let a = pa(p);
                let b = if a.is_some() { pb(p) } else { None };
                let c = if b.is_some() { pc(p) } else { None };
                match (a, b, c) {
                    (Some(a), Some(b), Some(c)) => Some((a, b, c)),
                    _ => None
                }
            })
        }

        // Read next char
        fn read_char(&mut self) -> Option<char> {
            if self.is_eof() {
                None
            } else {
                let r = self.s[self.pos] as char;
                self.pos += 1;
                Some(r)
            }
        }

        // Return char and advance iff next char is equal to requested
        fn read_given_char(&mut self, c: char) -> Option<char> {
            self.read_atomically(|p| {
                match p.read_char() {
                    Some(next) if next == c => Some(next),
                    _ => None,
                }
            })
        }

        // Read digit
        fn read_digit(&mut self, radix: u8) -> Option<u8> {
            fn parse_digit(c: char, radix: u8) -> Option<u8> {
                let c = c as u8;
                // assuming radix is either 10 or 16
                if c >= b'0' && c <= b'9' {
                    Some(c - b'0')
                } else if radix > 10 && c >= b'a' && c < b'a' + (radix - 10) {
                    Some(c - b'a' + 10)
                } else if radix > 10 && c >= b'A' && c < b'A' + (radix - 10) {
                    Some(c - b'A' + 10)
                } else {
                    None
                }
            }

            self.read_atomically(|p| {
                p.read_char().and_then(|c| parse_digit(c, radix))
            })
        }

        fn read_number_impl(&mut self, radix: u8, max_digits: u32, upto: u32) -> Option<u32> {
            let mut r = 0;
            let mut digit_count = 0;
            loop {
                match self.read_digit(radix) {
                    Some(d) => {
                        r = r * (radix as u32) + (d as u32);
                        digit_count += 1;
                        if digit_count > max_digits || r >= upto {
                            return None
                        }
                    }
                    None => {
                        if digit_count == 0 {
                            return None
                        } else {
                            return Some(r)
                        }
                    }
                };
            }
        }

        // Read number, failing if max_digits of number value exceeded
        fn read_number(&mut self, radix: u8, max_digits: u32, upto: u32) -> Option<u32> {
            self.read_atomically(|p| p.read_number_impl(radix, max_digits, upto))
        }

        fn read_ipv4_addr_impl(&mut self) -> Option<Ipv4Addr> {
            let mut bs = [0; 4];
            let mut i = 0;
            while i < 4 {
                if i != 0 && self.read_given_char('.').is_none() {
                    return None;
                }

                bs[i] = self.read_number(10, 3, 0x100).map(|n| n as u8)?;
                i += 1;
            }
            Some(Ipv4Addr::new(bs[0], bs[1], bs[2], bs[3]))
        }

        // Read IPv4 address
        fn read_ipv4_addr(&mut self) -> Option<Ipv4Addr> {
            self.read_atomically(|p| p.read_ipv4_addr_impl())
        }

        fn read_ipv6_addr_impl(&mut self) -> Option<Ipv6Addr> {
            fn ipv6_addr_from_head_tail(head: &[u16], tail: &[u16]) -> Ipv6Addr {
                assert!(head.len() + tail.len() <= 8);
                let mut gs = [0; 8];
                gs[..head.len()].copy_from_slice(head);
                gs[(8 - tail.len()) .. 8].copy_from_slice(tail);
                Ipv6Addr::new(gs[0], gs[1], gs[2], gs[3], gs[4], gs[5], gs[6], gs[7])
            }

            fn read_groups(p: &mut Parser, groups: &mut [u16; 8], limit: usize)
                           -> (usize, bool) {
                let mut i = 0;
                while i < limit {
                    if i < limit - 1 {
                        let ipv4 = p.read_atomically(|p| {
                            if i == 0 || p.read_given_char(':').is_some() {
                                p.read_ipv4_addr()
                            } else {
                                None
                            }
                        });
                        if let Some(v4_addr) = ipv4 {
                            let octets = v4_addr.octets();
                            groups[i + 0] = ((octets[0] as u16) << 8) | (octets[1] as u16);
                            groups[i + 1] = ((octets[2] as u16) << 8) | (octets[3] as u16);
                            return (i + 2, true);
                        }
                    }

                    let group = p.read_atomically(|p| {
                        if i == 0 || p.read_given_char(':').is_some() {
                            p.read_number(16, 4, 0x10000).map(|n| n as u16)
                        } else {
                            None
                        }
                    });
                    match group {
                        Some(g) => groups[i] = g,
                        None => return (i, false)
                    }
                    i += 1;
                }
                (i, false)
            }

            let mut head = [0; 8];
            let (head_size, head_ipv4) = read_groups(self, &mut head, 8);

            if head_size == 8 {
                return Some(Ipv6Addr::new(
                    head[0], head[1], head[2], head[3],
                    head[4], head[5], head[6], head[7]))
            }

            // IPv4 part is not allowed before `::`
            if head_ipv4 {
                return None
            }

            // read `::` if previous code parsed less than 8 groups
            if !self.read_given_char(':').is_some() || !self.read_given_char(':').is_some() {
                return None;
            }

            let mut tail = [0; 8];
            // `::` indicates one or more groups of 16 bits of zeros
            let limit = 8 - (head_size + 1);
            let (tail_size, _) = read_groups(self, &mut tail, limit);
            Some(ipv6_addr_from_head_tail(&head[..head_size], &tail[..tail_size]))
        }

        fn read_ipv6_addr(&mut self) -> Option<Ipv6Addr> {
            self.read_atomically(|p| p.read_ipv6_addr_impl())
        }

        fn read_ip_addr(&mut self) -> Option<IpAddr> {
            let ipv4_addr = |p: &mut Parser| p.read_ipv4_addr().map(IpAddr::V4);
            let ipv6_addr = |p: &mut Parser| p.read_ipv6_addr().map(IpAddr::V6);
            self.read_or(&mut [Box::new(ipv4_addr), Box::new(ipv6_addr)])
        }

        fn read_socket_addr_v4(&mut self) -> Option<SocketAddrV4> {
            let ip_addr = |p: &mut Parser| p.read_ipv4_addr();
            let colon = |p: &mut Parser| p.read_given_char(':');
            let port = |p: &mut Parser| {
                p.read_number(10, 5, 0x10000).map(|n| n as u16)
            };

            self.read_seq_3(ip_addr, colon, port).map(|t| {
                let (ip, _, port): (Ipv4Addr, char, u16) = t;
                SocketAddrV4::new(ip, port)
            })
        }

        fn read_socket_addr_v6(&mut self) -> Option<SocketAddrV6> {
            let ip_addr = |p: &mut Parser| {
                let open_br = |p: &mut Parser| p.read_given_char('[');
                let ip_addr = |p: &mut Parser| p.read_ipv6_addr();
                let clos_br = |p: &mut Parser| p.read_given_char(']');
                p.read_seq_3(open_br, ip_addr, clos_br).map(|t| t.1)
            };
            let colon = |p: &mut Parser| p.read_given_char(':');
            let port = |p: &mut Parser| {
                p.read_number(10, 5, 0x10000).map(|n| n as u16)
            };

            self.read_seq_3(ip_addr, colon, port).map(|t| {
                let (ip, _, port): (Ipv6Addr, char, u16) = t;
                SocketAddrV6::new(ip, port, 0, 0)
            })
        }

        fn read_socket_addr(&mut self) -> Option<SocketAddr> {
            let v4 = |p: &mut Parser| p.read_socket_addr_v4().map(SocketAddr::V4);
            let v6 = |p: &mut Parser| p.read_socket_addr_v6().map(SocketAddr::V6);
            self.read_or(&mut [Box::new(v4), Box::new(v6)])
        }
    }

    #[stable(feature = "ip_addr", since = "1.7.0")]
    impl FromStr for IpAddr {
        type Err = AddrParseError;
        fn from_str(s: &str) -> Result<IpAddr, AddrParseError> {
            match Parser::new(s).read_till_eof(|p| p.read_ip_addr()) {
                Some(s) => Ok(s),
                None => Err(AddrParseError(()))
            }
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl FromStr for Ipv4Addr {
        type Err = AddrParseError;
        fn from_str(s: &str) -> Result<Ipv4Addr, AddrParseError> {
            match Parser::new(s).read_till_eof(|p| p.read_ipv4_addr()) {
                Some(s) => Ok(s),
                None => Err(AddrParseError(()))
            }
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl FromStr for Ipv6Addr {
        type Err = AddrParseError;
        fn from_str(s: &str) -> Result<Ipv6Addr, AddrParseError> {
            match Parser::new(s).read_till_eof(|p| p.read_ipv6_addr()) {
                Some(s) => Ok(s),
                None => Err(AddrParseError(()))
            }
        }
    }

    #[stable(feature = "socket_addr_from_str", since = "1.5.0")]
    impl FromStr for SocketAddrV4 {
        type Err = AddrParseError;
        fn from_str(s: &str) -> Result<SocketAddrV4, AddrParseError> {
            match Parser::new(s).read_till_eof(|p| p.read_socket_addr_v4()) {
                Some(s) => Ok(s),
                None => Err(AddrParseError(())),
            }
        }
    }

    #[stable(feature = "socket_addr_from_str", since = "1.5.0")]
    impl FromStr for SocketAddrV6 {
        type Err = AddrParseError;
        fn from_str(s: &str) -> Result<SocketAddrV6, AddrParseError> {
            match Parser::new(s).read_till_eof(|p| p.read_socket_addr_v6()) {
                Some(s) => Ok(s),
                None => Err(AddrParseError(())),
            }
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl FromStr for SocketAddr {
        type Err = AddrParseError;
        fn from_str(s: &str) -> Result<SocketAddr, AddrParseError> {
            match Parser::new(s).read_till_eof(|p| p.read_socket_addr()) {
                Some(s) => Ok(s),
                None => Err(AddrParseError(())),
            }
        }
    }

    /// An error which can be returned when parsing an IP address or a socket address.
    ///
    /// This error is used as the error type for the [`FromStr`] implementation for
    /// [`IpAddr`], [`Ipv4Addr`], [`Ipv6Addr`], [`SocketAddr`], [`SocketAddrV4`], and
    /// [`SocketAddrV6`].
    ///
    /// # Potential causes
    ///
    /// `AddrParseError` may be thrown because the provided string does not parse as the given type,
    /// often because it includes information only handled by a different address type.
    ///
    /// ```should_panic
    /// use std::net::IpAddr;
    /// let _foo: IpAddr = "127.0.0.1:8080".parse().expect("Cannot handle the socket port");
    /// ```
    ///
    /// [`IpAddr`] doesn't handle the port. Use [`SocketAddr`] instead.
    ///
    /// ```
    /// use std::net::SocketAddr;
    ///
    /// // No problem, the `panic!` message has disappeared.
    /// let _foo: SocketAddr = "127.0.0.1:8080".parse().expect("unreachable panic");
    /// ```
    ///
    /// [`FromStr`]: ../../std/str/trait.FromStr.html
    /// [`IpAddr`]: ../../std/net/enum.IpAddr.html
    /// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
    /// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
    /// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
    /// [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
    /// [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
    #[stable(feature = "rust1", since = "1.0.0")]
    #[derive(Debug, Clone, PartialEq, Eq)]
    pub struct AddrParseError(());

    #[stable(feature = "addr_parse_error_error", since = "1.4.0")]
    impl fmt::Display for AddrParseError {
        fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
            fmt.write_str(self.description())
        }
    }

    #[stable(feature = "addr_parse_error_error", since = "1.4.0")]
    impl Error for AddrParseError {
        fn description(&self) -> &str {
            "invalid IP address syntax"
        }
    }

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