       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
     415
     416
     417
     418
     419
     420
     421
     422
     423
     424
     425
     426
     427
     428
     429
     430
     431
     432
     433
     434
     435
     436
     437
     438
     439
     440
     441
     442
     443
     444
     445
     446
     447
     448
     449
     450
     451
     452
     453
     454
     455
     456
     457
     458
     459
     460
     461
     462
     463
     464
     465
     466
     467
     468
     469
     470
     471
     472
     473
     474
     475
     476
     477
     478
     479
     480
     481
     482
     483
     484
     485
     486
     487
     488
     489
     490
     491
     492
     493
     494
     495
     496
     497
     498
     499
     500
     501
     502
     503
     504
     505
     506
     507
     508
     509
     510
     511
     512
     513
     514
     515
     516
     517
     518
     519
     520
     521
     522
     523
     524
     525
     526
     527
     528
     529
     530
     531
     532
     533
     534
     535
     536
     537
     538
     539
     540
     541
     542
     543
     544
     545
     546
     547
     548
     549
     550
     551
     552
     553
     554
     555
     556
     557
     558
     559
     560
     561
     562
     563
     564
     565
     566
     567
     568
     569
     570
     571
     572
     573
     574
     575
     576
     577
     578
     579
     580
     581
     582
     583
     584
     585
     586
     587
     588
     589
     590
     591
     592
     593
     594
     595
     596
     597
     598
     599
     600
     601
     602
     603
     604
     605
     606
     607
     608
     609
     610
     611
     612
     613
     614
     615
     616
     617
     618
     619
     620
     621
     622
     623
     624
     625
     626
     627
     628
     629
     630
     631
     632
     633
     634
     635
     636
     637
     638
     639
     640
     641
     642
     643
     644
     645
     646
     647
     648
     649
     650
     651
     652
     653
     654
     655
     656
     657
     658
     659
     660
     661
     662
     663
     664
     665
     666
     667
     668
     669
     670
     671
     672
     673
     674
     675
     676
     677
     678
     679
     680
     681
     682
     683
     684
     685
     686
     687
     688
     689
     690
     691
     692
     693
     694
     695
     696
     697
     698
     699
     700
     701
     702
     703
     704
     705
     706
     707
     708
     709
     710
     711
     712
     713
     714
     715
     716
     717
     718
     719
     720
     721
     722
     723
     724
     725
     726
     727
     728
     729
     730
     731
     732
     733
     734
     735
     736
     737
     738
     739
     740
     741
     742
     743
     744
     745
     746
     747
     748
     749
     750
     751
     752
     753
     754
     755
     756
     757
     758
     759
     760
     761
     762
     763
     764
     765
     766
     767
     768
     769
     770
     771
     772
     773
     774
     775
     776
     777
     778
     779
     780
     781
     782
     783
     784
     785
     786
     787
     788
     789
     790
     791
     792
     793
     794
     795
     796
     797
     798
     799
     800
     801
     802
     803
     804
     805
     806
     807
     808
     809
     810
     811
     812
     813
     814
     815
     816
     817
     818
     819
     820
     821
     822
     823
     824
     825
     826
     827
     828
     829
     830
     831
     832
     833
     834
     835
     836
     837
     838
     839
     840
     841
     842
     843
     844
     845
     846
     847
     848
     849
     850
     851
     852
     853
     854
     855
     856
     857
     858
     859
     860
     861
     862
     863
     864
     865
     866
     867
     868
     869
     870
     871
     872
     873
     874
     875
     876
     877
     878
     879
     880
     881
     882
     883
     884
     885
     886
     887
     888
     889
     890
     891
     892
     893
     894
     895
     896
     897
     898
     899
     900
     901
     902
     903
     904
     905
     906
     907
     908
     909
     910
     911
     912
     913
     914
     915
     916
     917
     918
     919
     920
     921
     922
     923
     924
     925
     926
     927
     928
     929
     930
     931
     932
     933
     934
     935
     936
     937
     938
     939
     940
     941
     942
     943
     944
     945
     946
     947
     948
     949
     950
     951
     952
     953
     954
     955
     956
     957
     958
     959
     960
     961
     962
     963
     964
     965
     966
     967
     968
     969
     970
     971
     972
     973
     974
     975
     976
     977
     978
     979
     980
     981
     982
     983
     984
     985
     986
     987
     988
     989
     990
     991
     992
     993
     994
     995
     996
     997
     998
     999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    1076
    1077
    1078
    1079
    1080
    1081
    1082
    1083
    1084
    1085
    1086
    1087
    1088
    1089
    1090
    1091
    1092
    1093
    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    1129
    1130
    1131
    1132
    1133
    1134
    1135
    1136
    1137
    1138
    1139
    1140
    1141
    1142
    1143
    1144
    1145
    1146
    1147
    1148
    1149
    1150
    1151
    1152
    1153
    1154
    1155
    1156
    1157
    1158
    1159
    1160
    1161
    1162
    1163
    1164
    1165
    1166
    1167
    1168
    1169
    1170
    1171
    1172
    1173
    1174
    1175
    1176
    1177
    1178
    1179
    1180
    1181
    1182
    1183
    1184
    1185
    1186
    1187
    1188
    1189
    1190
    1191
    1192
    1193
    1194
    1195
    1196
    1197
    1198
    1199
    1200
    1201
    1202
    1203
    1204
    1205
    1206
    1207
    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    1220
    1221
    1222
    1223
    1224
    1225
    1226
    1227
    1228
    1229
    1230
    1231
    1232
    1233
    1234
    1235
    1236
    1237
    1238
    1239
    1240
    1241
    1242
    1243
    1244
    1245
    1246
    1247
    1248
    1249
    1250
    1251
    1252
    1253
    1254
    1255
    1256
    1257
    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    1288
    1289
    1290
    1291
    1292
    1293
    1294
    1295
    1296
    1297
    1298
    1299
    1300
    1301
    1302
    1303
    1304
    1305
    1306
    1307
    1308
    1309
    1310
    1311
    1312
    1313
    1314
    1315
    1316
    1317
    1318
    1319
    1320
    1321
    1322
    1323
    1324
    1325
    1326
    1327
    1328
    1329
    1330
    1331
    1332
    1333
    1334
    1335
    1336
    1337
    1338
    1339
    1340
    1341
    1342
    1343
    1344
    1345
    1346
    1347
    1348
    1349
    1350
    1351
    1352
    1353
    1354
    1355
    1356
    1357
    1358
    1359
    1360
    1361
    1362
    1363
    1364
    1365
    1366
    1367
    1368
    1369
    1370
    1371
    1372
    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    1397
    1398
    1399
    1400
    1401
    1402
    1403
    1404
    1405
    1406
    1407
    1408
    1409
    1410
    1411
    1412
    1413
    1414
    1415
    1416
    1417
    1418
    1419
    1420
    1421
    1422
    1423
    1424
    1425
    1426
    1427
    1428
    1429
    1430
    1431
    1432
    1433
    1434
    1435
    1436
    1437
    1438
    1439
    1440
    1441
    1442
    1443
    1444
    1445
    1446
    1447
    1448
    1449
    1450
    1451
    1452
    1453
    1454
    1455
    1456
    1457
    1458
    1459
    1460
    1461
    1462
    1463
    1464
    1465
    1466
    1467
    1468
    1469
    1470
    1471
    1472
    1473
    1474
    1475
    1476
    1477
    1478
    1479
    1480
    1481
    1482
    1483
    1484
    1485
    1486
    1487
    1488
    1489
    1490
    1491
    1492
    1493
    1494
    1495
    1496
    1497
    1498
    1499
    1500
    1501
    1502
    1503
    1504
    1505
    1506
    1507
    1508
    1509
    1510
    1511
    1512
    1513
    1514
    1515
    1516
    1517
    1518
    1519
    1520
    1521
    1522
    1523
    1524
    1525
    1526
    1527
    1528
    1529
    1530
    1531
    1532
    1533
    1534
    1535
    1536
    1537
    1538
    1539
    1540
    1541
    1542
    1543
    1544
    1545
    1546
    1547
    1548
    1549
    1550
    1551
    1552
    1553
    1554
    1555
    1556
    1557
    1558
    1559
    1560
    1561
    1562
    1563
    1564
    1565
    1566
    1567
    1568
    1569
    1570
    1571
    1572
    1573
    1574
    1575
    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    1624
    1625
    1626
    1627
    1628
    1629
    1630
    1631
    1632
    1633
    1634
    1635
    1636
    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    1670
    1671
    1672
    1673
    1674
    1675
    1676
    1677
    1678
    1679
    1680
    1681
    1682
    1683
    1684
    1685
    1686
    1687
    1688
    1689
    1690
    1691
    1692
    1693
    1694
    1695
    1696
    1697
    1698
    1699
    1700
    1701
    1702
    1703
    1704
    1705
    1706
    1707
    1708
    1709
    1710
    1711
    1712
    1713
    1714
    1715
    1716
    1717
    1718
    1719
    1720
    1721
    1722
    1723
    1724
    1725
    1726
    1727
    1728
    1729
    1730
    1731
    1732
    1733
    1734
    1735
    1736
    1737
    1738
    1739
    1740
    1741
    1742
    1743
    1744
    1745
    1746
    1747
    1748
    1749
    1750
    1751
    1752
    1753
    1754
    1755
    1756
    1757
    1758
    1759
    1760
    1761
    1762
    1763
    1764
    1765
    1766
    1767
    1768
    1769
    1770
    1771
    1772
    1773
    1774
    1775
    1776
    1777
    1778
    1779
    1780
    1781
    1782
    1783
    1784
    1785
    1786
    1787
    1788
    1789
    1790
    1791
    1792
    1793
    1794
    1795
    1796
    1797
    1798
    1799
    1800
    1801
    1802
    1803
    1804
    1805
    1806
    1807
    1808
    1809
    1810
    1811
    1812
    1813
    1814
    1815
    1816
    1817
    1818
    1819
    1820
    1821
    1822
    1823
    1824
    1825
    1826
    1827
    1828
    1829
    1830
    1831
    1832
    1833
    1834
    1835
    1836
    1837
    1838
    1839
    1840
    1841
    1842
    1843
    1844
    1845
    1846
    1847
    1848
    1849
    1850
    1851
    1852
    1853
    1854
    1855
    1856
    1857
    1858
    1859
    1860
    1861
    1862
    1863
    1864
    1865
    1866
    1867
    1868
    1869
    1870
    1871
    1872
    1873
    1874
    1875
    1876
    1877
    1878
    1879
    1880
    1881
    1882
    1883
    1884
    1885
    1886
    1887
    1888
    1889
    1890
    1891
    1892
    1893
    1894
    1895
    1896
    1897
    1898
    1899
    1900
    1901
    1902
    1903
    1904
    1905
    1906
    1907
    1908
    1909
    1910
    1911
    1912
    1913
    1914
    1915
    1916
    1917
    1918
    1919
    1920
    1921
    1922
    1923
    1924
    1925
    1926
    1927
    1928
    1929
    1930
    1931
    1932
    1933
    1934
    1935
    1936
    1937
    1938
    1939
    1940
    1941
    1942
    1943
    1944
    1945
    1946
    1947
    1948
    1949
    1950
    1951
    1952
    1953
    1954
    1955
    1956
    1957
    1958
    1959
    1960
    1961
    1962
    1963
    1964
    1965
    1966
    1967
    1968
    1969
    1970
    1971
    1972
    1973
    1974
    1975
    1976
    1977
    1978
    1979
    1980
    1981
    1982
    1983
    1984
    1985
    1986
    1987
    1988
    1989
    1990
    1991
    1992
    1993
    1994
    1995
    1996
    1997
    1998
    1999
    2000
    2001
    2002
    2003
    2004
    2005
    2006
    2007
    2008
    2009
    2010
    2011
    2012
    2013
    2014
    2015
    2016
    2017
    2018
    2019
    2020
    2021
    2022
    2023
    2024
    2025
    2026
    2027
    2028
    2029
    2030
    2031
    2032
    2033
    2034
    2035
    2036
    2037
    2038
    2039
    2040
    2041
    2042
    2043
    2044
    2045
    2046
    2047
    2048
    2049
    2050
    2051
    2052
    2053
    2054
    2055
    2056
    2057
    2058
    2059
    2060
    2061
    2062
    2063
    2064
    2065
    2066
    2067
    2068
    2069
    2070
    2071
    2072
    2073
    2074
    2075
    2076
    2077
    2078
    2079
    2080
    2081
    2082
    2083
    2084
    2085
    2086
    2087
    2088
    2089
    2090
    2091
    2092
    2093
    2094
    2095
    2096
    2097
    2098
    2099
    2100
    2101
    2102
    2103
    2104
    2105
    2106
    2107
    2108
    2109
    2110
    2111
    2112
    2113
    2114
    2115
    2116
    2117
    2118
    2119
    2120
    2121
    2122
    2123
    2124
    2125
    2126
    2127
    2128
    2129
    2130
    2131
    2132
    2133
    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    2144
    2145
    2146
    2147
    2148
    2149
    2150
    2151
    2152
    2153
    2154
    2155
    2156
    2157
    2158
    2159
    2160
    2161
    2162
    2163
    2164
    2165
    2166
    2167
    2168
    2169
    2170
    2171
    2172
    2173
    2174
    2175
    2176
    2177
    2178
    2179
    2180
    2181
    2182
    2183
    2184
    2185
    2186
    2187
    2188
    2189
    2190
    2191
    2192
    2193
    2194
    2195
    2196
    2197
    2198
    2199
    2200
    2201
    2202
    2203
    2204
    2205
    2206
    2207
    2208
    2209
    2210
    2211
    2212
    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    2227
    2228
    2229
    2230
    2231
    2232
    2233
    2234
    2235
    2236
    2237
    2238
    2239
    2240
    2241
    2242
    2243
    2244
    2245
    2246
    2247
    2248
    2249
    2250
    2251
    2252
    2253
    2254

    //! Traits, helpers, and type definitions for core I/O functionality.
    //!
    //! The `std::io` module contains a number of common things you'll need
    //! when doing input and output. The most core part of this module is
    //! the [`Read`] and [`Write`] traits, which provide the
    //! most general interface for reading and writing input and output.
    //!
    //! # Read and Write
    //!
    //! Because they are traits, [`Read`] and [`Write`] are implemented by a number
    //! of other types, and you can implement them for your types too. As such,
    //! you'll see a few different types of I/O throughout the documentation in
    //! this module: [`File`]s, [`TcpStream`]s, and sometimes even [`Vec<T>`]s. For
    //! example, [`Read`] adds a [`read`][`Read::read`] method, which we can use on
    //! [`File`]s:
    //!
    //! ```no_run
    //! use std::io;
    //! use std::io::prelude::*;
    //! use std::fs::File;
    //!
    //! fn main() -> io::Result<()> {
    //!     let mut f = File::open("foo.txt")?;
    //!     let mut buffer = [0; 10];
    //!
    //!     // read up to 10 bytes
    //!     f.read(&mut buffer)?;
    //!
    //!     println!("The bytes: {:?}", buffer);
    //!     Ok(())
    //! }
    //! ```
    //!
    //! [`Read`] and [`Write`] are so important, implementors of the two traits have a
    //! nickname: readers and writers. So you'll sometimes see 'a reader' instead
    //! of 'a type that implements the [`Read`] trait'. Much easier!
    //!
    //! ## Seek and BufRead
    //!
    //! Beyond that, there are two important traits that are provided: [`Seek`]
    //! and [`BufRead`]. Both of these build on top of a reader to control
    //! how the reading happens. [`Seek`] lets you control where the next byte is
    //! coming from:
    //!
    //! ```no_run
    //! use std::io;
    //! use std::io::prelude::*;
    //! use std::io::SeekFrom;
    //! use std::fs::File;
    //!
    //! fn main() -> io::Result<()> {
    //!     let mut f = File::open("foo.txt")?;
    //!     let mut buffer = [0; 10];
    //!
    //!     // skip to the last 10 bytes of the file
    //!     f.seek(SeekFrom::End(-10))?;
    //!
    //!     // read up to 10 bytes
    //!     f.read(&mut buffer)?;
    //!
    //!     println!("The bytes: {:?}", buffer);
    //!     Ok(())
    //! }
    //! ```
    //!
    //! [`BufRead`] uses an internal buffer to provide a number of other ways to read, but
    //! to show it off, we'll need to talk about buffers in general. Keep reading!
    //!
    //! ## BufReader and BufWriter
    //!
    //! Byte-based interfaces are unwieldy and can be inefficient, as we'd need to be
    //! making near-constant calls to the operating system. To help with this,
    //! `std::io` comes with two structs, [`BufReader`] and [`BufWriter`], which wrap
    //! readers and writers. The wrapper uses a buffer, reducing the number of
    //! calls and providing nicer methods for accessing exactly what you want.
    //!
    //! For example, [`BufReader`] works with the [`BufRead`] trait to add extra
    //! methods to any reader:
    //!
    //! ```no_run
    //! use std::io;
    //! use std::io::prelude::*;
    //! use std::io::BufReader;
    //! use std::fs::File;
    //!
    //! fn main() -> io::Result<()> {
    //!     let f = File::open("foo.txt")?;
    //!     let mut reader = BufReader::new(f);
    //!     let mut buffer = String::new();
    //!
    //!     // read a line into buffer
    //!     reader.read_line(&mut buffer)?;
    //!
    //!     println!("{}", buffer);
    //!     Ok(())
    //! }
    //! ```
    //!
    //! [`BufWriter`] doesn't add any new ways of writing; it just buffers every call
    //! to [`write`][`Write::write`]:
    //!
    //! ```no_run
    //! use std::io;
    //! use std::io::prelude::*;
    //! use std::io::BufWriter;
    //! use std::fs::File;
    //!
    //! fn main() -> io::Result<()> {
    //!     let f = File::create("foo.txt")?;
    //!     {
    //!         let mut writer = BufWriter::new(f);
    //!
    //!         // write a byte to the buffer
    //!         writer.write(&[42])?;
    //!
    //!     } // the buffer is flushed once writer goes out of scope
    //!
    //!     Ok(())
    //! }
    //! ```
    //!
    //! ## Standard input and output
    //!
    //! A very common source of input is standard input:
    //!
    //! ```no_run
    //! use std::io;
    //!
    //! fn main() -> io::Result<()> {
    //!     let mut input = String::new();
    //!
    //!     io::stdin().read_line(&mut input)?;
    //!
    //!     println!("You typed: {}", input.trim());
    //!     Ok(())
    //! }
    //! ```
    //!
    //! Note that you cannot use the [`?` operator] in functions that do not return
    //! a [`Result<T, E>`][`Result`]. Instead, you can call [`.unwrap()`]
    //! or `match` on the return value to catch any possible errors:
    //!
    //! ```no_run
    //! use std::io;
    //!
    //! let mut input = String::new();
    //!
    //! io::stdin().read_line(&mut input).unwrap();
    //! ```
    //!
    //! And a very common source of output is standard output:
    //!
    //! ```no_run
    //! use std::io;
    //! use std::io::prelude::*;
    //!
    //! fn main() -> io::Result<()> {
    //!     io::stdout().write(&[42])?;
    //!     Ok(())
    //! }
    //! ```
    //!
    //! Of course, using [`io::stdout`] directly is less common than something like
    //! [`println!`].
    //!
    //! ## Iterator types
    //!
    //! A large number of the structures provided by `std::io` are for various
    //! ways of iterating over I/O. For example, [`Lines`] is used to split over
    //! lines:
    //!
    //! ```no_run
    //! use std::io;
    //! use std::io::prelude::*;
    //! use std::io::BufReader;
    //! use std::fs::File;
    //!
    //! fn main() -> io::Result<()> {
    //!     let f = File::open("foo.txt")?;
    //!     let reader = BufReader::new(f);
    //!
    //!     for line in reader.lines() {
    //!         println!("{}", line?);
    //!     }
    //!     Ok(())
    //! }
    //! ```
    //!
    //! ## Functions
    //!
    //! There are a number of [functions][functions-list] that offer access to various
    //! features. For example, we can use three of these functions to copy everything
    //! from standard input to standard output:
    //!
    //! ```no_run
    //! use std::io;
    //!
    //! fn main() -> io::Result<()> {
    //!     io::copy(&mut io::stdin(), &mut io::stdout())?;
    //!     Ok(())
    //! }
    //! ```
    //!
    //! [functions-list]: #functions-1
    //!
    //! ## io::Result
    //!
    //! Last, but certainly not least, is [`io::Result`]. This type is used
    //! as the return type of many `std::io` functions that can cause an error, and
    //! can be returned from your own functions as well. Many of the examples in this
    //! module use the [`?` operator]:
    //!
    //! ```
    //! use std::io;
    //!
    //! fn read_input() -> io::Result<()> {
    //!     let mut input = String::new();
    //!
    //!     io::stdin().read_line(&mut input)?;
    //!
    //!     println!("You typed: {}", input.trim());
    //!
    //!     Ok(())
    //! }
    //! ```
    //!
    //! The return type of `read_input()`, [`io::Result<()>`][`io::Result`], is a very
    //! common type for functions which don't have a 'real' return value, but do want to
    //! return errors if they happen. In this case, the only purpose of this function is
    //! to read the line and print it, so we use `()`.
    //!
    //! ## Platform-specific behavior
    //!
    //! Many I/O functions throughout the standard library are documented to indicate
    //! what various library or syscalls they are delegated to. This is done to help
    //! applications both understand what's happening under the hood as well as investigate
    //! any possibly unclear semantics. Note, however, that this is informative, not a binding
    //! contract. The implementation of many of these functions are subject to change over
    //! time and may call fewer or more syscalls/library functions.
    //!
    //! [`Read`]: trait.Read.html
    //! [`Write`]: trait.Write.html
    //! [`Seek`]: trait.Seek.html
    //! [`BufRead`]: trait.BufRead.html
    //! [`File`]: ../fs/struct.File.html
    //! [`TcpStream`]: ../net/struct.TcpStream.html
    //! [`Vec<T>`]: ../vec/struct.Vec.html
    //! [`BufReader`]: struct.BufReader.html
    //! [`BufWriter`]: struct.BufWriter.html
    //! [`Write::write`]: trait.Write.html#tymethod.write
    //! [`io::stdout`]: fn.stdout.html
    //! [`println!`]: ../macro.println.html
    //! [`Lines`]: struct.Lines.html
    //! [`io::Result`]: type.Result.html
    //! [`?` operator]: ../../book/appendix-02-operators.html
    //! [`Read::read`]: trait.Read.html#tymethod.read
    //! [`Result`]: ../result/enum.Result.html
    //! [`.unwrap()`]: ../result/enum.Result.html#method.unwrap

    #![stable(feature = "rust1", since = "1.0.0")]

    use cmp;
    use fmt;
    use slice;
    use str;
    use memchr;
    use ptr;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::buffered::{BufReader, BufWriter, LineWriter};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::buffered::IntoInnerError;
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::cursor::Cursor;
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::error::{Result, Error, ErrorKind};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::util::{copy, sink, Sink, empty, Empty, repeat, Repeat};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::stdio::{stdin, stdout, stderr, Stdin, Stdout, Stderr};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::stdio::{StdoutLock, StderrLock, StdinLock};
    #[unstable(feature = "print_internals", issue = "0")]
    pub use self::stdio::{_print, _eprint};
    #[unstable(feature = "libstd_io_internals", issue = "42788")]
    #[doc(no_inline, hidden)]
    pub use self::stdio::{set_panic, set_print};

    pub mod prelude;
    mod buffered;
    mod cursor;
    mod error;
    mod impls;
    mod lazy;
    mod util;
    mod stdio;

    const DEFAULT_BUF_SIZE: usize = ::sys_common::io::DEFAULT_BUF_SIZE;

    struct Guard<'a> { buf: &'a mut Vec<u8>, len: usize }

    impl<'a> Drop for Guard<'a> {
        fn drop(&mut self) {
            unsafe { self.buf.set_len(self.len); }
        }
    }

    // A few methods below (read_to_string, read_line) will append data into a
    // `String` buffer, but we need to be pretty careful when doing this. The
    // implementation will just call `.as_mut_vec()` and then delegate to a
    // byte-oriented reading method, but we must ensure that when returning we never
    // leave `buf` in a state such that it contains invalid UTF-8 in its bounds.
    //
    // To this end, we use an RAII guard (to protect against panics) which updates
    // the length of the string when it is dropped. This guard initially truncates
    // the string to the prior length and only after we've validated that the
    // new contents are valid UTF-8 do we allow it to set a longer length.
    //
    // The unsafety in this function is twofold:
    //
    // 1. We're looking at the raw bytes of `buf`, so we take on the burden of UTF-8
    //    checks.
    // 2. We're passing a raw buffer to the function `f`, and it is expected that
    //    the function only *appends* bytes to the buffer. We'll get undefined
    //    behavior if existing bytes are overwritten to have non-UTF-8 data.
    fn append_to_string<F>(buf: &mut String, f: F) -> Result<usize>
        where F: FnOnce(&mut Vec<u8>) -> Result<usize>
    {
        unsafe {
            let mut g = Guard { len: buf.len(), buf: buf.as_mut_vec() };
            let ret = f(g.buf);
            if str::from_utf8(&g.buf[g.len..]).is_err() {
                ret.and_then(|_| {
                    Err(Error::new(ErrorKind::InvalidData,
                                   "stream did not contain valid UTF-8"))
                })
            } else {
                g.len = g.buf.len();
                ret
            }
        }
    }

    // This uses an adaptive system to extend the vector when it fills. We want to
    // avoid paying to allocate and zero a huge chunk of memory if the reader only
    // has 4 bytes while still making large reads if the reader does have a ton
    // of data to return. Simply tacking on an extra DEFAULT_BUF_SIZE space every
    // time is 4,500 times (!) slower than a default reservation size of 32 if the
    // reader has a very small amount of data to return.
    //
    // Because we're extending the buffer with uninitialized data for trusted
    // readers, we need to make sure to truncate that if any of this panics.
    fn read_to_end<R: Read + ?Sized>(r: &mut R, buf: &mut Vec<u8>) -> Result<usize> {
        read_to_end_with_reservation(r, buf, 32)
    }

    fn read_to_end_with_reservation<R: Read + ?Sized>(r: &mut R,
                                                      buf: &mut Vec<u8>,
                                                      reservation_size: usize) -> Result<usize>
    {
        let start_len = buf.len();
        let mut g = Guard { len: buf.len(), buf: buf };
        let ret;
        loop {
            if g.len == g.buf.len() {
                unsafe {
                    g.buf.reserve(reservation_size);
                    let capacity = g.buf.capacity();
                    g.buf.set_len(capacity);
                    r.initializer().initialize(&mut g.buf[g.len..]);
                }
            }

            match r.read(&mut g.buf[g.len..]) {
                Ok(0) => {
                    ret = Ok(g.len - start_len);
                    break;
                }
                Ok(n) => g.len += n,
                Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
                Err(e) => {
                    ret = Err(e);
                    break;
                }
            }
        }

        ret
    }

    /// The `Read` trait allows for reading bytes from a source.
    ///
    /// Implementors of the `Read` trait are called 'readers'.
    ///
    /// Readers are defined by one required method, [`read()`]. Each call to [`read()`]
    /// will attempt to pull bytes from this source into a provided buffer. A
    /// number of other methods are implemented in terms of [`read()`], giving
    /// implementors a number of ways to read bytes while only needing to implement
    /// a single method.
    ///
    /// Readers are intended to be composable with one another. Many implementors
    /// throughout [`std::io`] take and provide types which implement the `Read`
    /// trait.
    ///
    /// Please note that each call to [`read()`] may involve a system call, and
    /// therefore, using something that implements [`BufRead`], such as
    /// [`BufReader`], will be more efficient.
    ///
    /// # Examples
    ///
    /// [`File`]s implement `Read`:
    ///
    /// ```no_run
    /// use std::io;
    /// use std::io::prelude::*;
    /// use std::fs::File;
    ///
    /// fn main() -> io::Result<()> {
    ///     let mut f = File::open("foo.txt")?;
    ///     let mut buffer = [0; 10];
    ///
    ///     // read up to 10 bytes
    ///     f.read(&mut buffer)?;
    ///
    ///     let mut buffer = Vec::new();
    ///     // read the whole file
    ///     f.read_to_end(&mut buffer)?;
    ///
    ///     // read into a String, so that you don't need to do the conversion.
    ///     let mut buffer = String::new();
    ///     f.read_to_string(&mut buffer)?;
    ///
    ///     // and more! See the other methods for more details.
    ///     Ok(())
    /// }
    /// ```
    ///
    /// Read from [`&str`] because [`&[u8]`][slice] implements `Read`:
    ///
    /// ```no_run
    /// # use std::io;
    /// use std::io::prelude::*;
    ///
    /// fn main() -> io::Result<()> {
    ///     let mut b = "This string will be read".as_bytes();
    ///     let mut buffer = [0; 10];
    ///
    ///     // read up to 10 bytes
    ///     b.read(&mut buffer)?;
    ///
    ///     // etc... it works exactly as a File does!
    ///     Ok(())
    /// }
    /// ```
    ///
    /// [`read()`]: trait.Read.html#tymethod.read
    /// [`std::io`]: ../../std/io/index.html
    /// [`File`]: ../fs/struct.File.html
    /// [`BufRead`]: trait.BufRead.html
    /// [`BufReader`]: struct.BufReader.html
    /// [`&str`]: ../../std/primitive.str.html
    /// [slice]: ../../std/primitive.slice.html
    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(spotlight)]
    pub trait Read {
        /// Pull some bytes from this source into the specified buffer, returning
        /// how many bytes were read.
        ///
        /// This function does not provide any guarantees about whether it blocks
        /// waiting for data, but if an object needs to block for a read but cannot
        /// it will typically signal this via an [`Err`] return value.
        ///
        /// If the return value of this method is [`Ok(n)`], then it must be
        /// guaranteed that `0 <= n <= buf.len()`. A nonzero `n` value indicates
        /// that the buffer `buf` has been filled in with `n` bytes of data from this
        /// source. If `n` is `0`, then it can indicate one of two scenarios:
        ///
        /// 1. This reader has reached its "end of file" and will likely no longer
        ///    be able to produce bytes. Note that this does not mean that the
        ///    reader will *always* no longer be able to produce bytes.
        /// 2. The buffer specified was 0 bytes in length.
        ///
        /// No guarantees are provided about the contents of `buf` when this
        /// function is called, implementations cannot rely on any property of the
        /// contents of `buf` being true. It is recommended that implementations
        /// only write data to `buf` instead of reading its contents.
        ///
        /// # Errors
        ///
        /// If this function encounters any form of I/O or other error, an error
        /// variant will be returned. If an error is returned then it must be
        /// guaranteed that no bytes were read.
        ///
        /// An error of the [`ErrorKind::Interrupted`] kind is non-fatal and the read
        /// operation should be retried if there is nothing else to do.
        ///
        /// # Examples
        ///
        /// [`File`]s implement `Read`:
        ///
        /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
        /// [`Ok(n)`]: ../../std/result/enum.Result.html#variant.Ok
        /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
        /// [`File`]: ../fs/struct.File.html
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///     let mut buffer = [0; 10];
        ///
        ///     // read up to 10 bytes
        ///     f.read(&mut buffer[..])?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn read(&mut self, buf: &mut [u8]) -> Result<usize>;

        /// Determines if this `Read`er can work with buffers of uninitialized
        /// memory.
        ///
        /// The default implementation returns an initializer which will zero
        /// buffers.
        ///
        /// If a `Read`er guarantees that it can work properly with uninitialized
        /// memory, it should call [`Initializer::nop()`]. See the documentation for
        /// [`Initializer`] for details.
        ///
        /// The behavior of this method must be independent of the state of the
        /// `Read`er - the method only takes `&self` so that it can be used through
        /// trait objects.
        ///
        /// # Safety
        ///
        /// This method is unsafe because a `Read`er could otherwise return a
        /// non-zeroing `Initializer` from another `Read` type without an `unsafe`
        /// block.
        ///
        /// [`Initializer::nop()`]: ../../std/io/struct.Initializer.html#method.nop
        /// [`Initializer`]: ../../std/io/struct.Initializer.html
        #[unstable(feature = "read_initializer", issue = "42788")]
        #[inline]
        unsafe fn initializer(&self) -> Initializer {
            Initializer::zeroing()
        }

        /// Read all bytes until EOF in this source, placing them into `buf`.
        ///
        /// All bytes read from this source will be appended to the specified buffer
        /// `buf`. This function will continuously call [`read()`] to append more data to
        /// `buf` until [`read()`] returns either [`Ok(0)`] or an error of
        /// non-[`ErrorKind::Interrupted`] kind.
        ///
        /// If successful, this function will return the total number of bytes read.
        ///
        /// # Errors
        ///
        /// If this function encounters an error of the kind
        /// [`ErrorKind::Interrupted`] then the error is ignored and the operation
        /// will continue.
        ///
        /// If any other read error is encountered then this function immediately
        /// returns. Any bytes which have already been read will be appended to
        /// `buf`.
        ///
        /// # Examples
        ///
        /// [`File`]s implement `Read`:
        ///
        /// [`read()`]: trait.Read.html#tymethod.read
        /// [`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok
        /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
        /// [`File`]: ../fs/struct.File.html
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///     let mut buffer = Vec::new();
        ///
        ///     // read the whole file
        ///     f.read_to_end(&mut buffer)?;
        ///     Ok(())
        /// }
        /// ```
        ///
        /// (See also the [`std::fs::read`] convenience function for reading from a
        /// file.)
        ///
        /// [`std::fs::read`]: ../fs/fn.read.html
        #[stable(feature = "rust1", since = "1.0.0")]
        fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize> {
            read_to_end(self, buf)
        }

        /// Read all bytes until EOF in this source, appending them to `buf`.
        ///
        /// If successful, this function returns the number of bytes which were read
        /// and appended to `buf`.
        ///
        /// # Errors
        ///
        /// If the data in this stream is *not* valid UTF-8 then an error is
        /// returned and `buf` is unchanged.
        ///
        /// See [`read_to_end`][readtoend] for other error semantics.
        ///
        /// [readtoend]: #method.read_to_end
        ///
        /// # Examples
        ///
        /// [`File`][file]s implement `Read`:
        ///
        /// [file]: ../fs/struct.File.html
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///     let mut buffer = String::new();
        ///
        ///     f.read_to_string(&mut buffer)?;
        ///     Ok(())
        /// }
        /// ```
        ///
        /// (See also the [`std::fs::read_to_string`] convenience function for
        /// reading from a file.)
        ///
        /// [`std::fs::read_to_string`]: ../fs/fn.read_to_string.html
        #[stable(feature = "rust1", since = "1.0.0")]
        fn read_to_string(&mut self, buf: &mut String) -> Result<usize> {
            // Note that we do *not* call `.read_to_end()` here. We are passing
            // `&mut Vec<u8>` (the raw contents of `buf`) into the `read_to_end`
            // method to fill it up. An arbitrary implementation could overwrite the
            // entire contents of the vector, not just append to it (which is what
            // we are expecting).
            //
            // To prevent extraneously checking the UTF-8-ness of the entire buffer
            // we pass it to our hardcoded `read_to_end` implementation which we
            // know is guaranteed to only read data into the end of the buffer.
            append_to_string(buf, |b| read_to_end(self, b))
        }

        /// Read the exact number of bytes required to fill `buf`.
        ///
        /// This function reads as many bytes as necessary to completely fill the
        /// specified buffer `buf`.
        ///
        /// No guarantees are provided about the contents of `buf` when this
        /// function is called, implementations cannot rely on any property of the
        /// contents of `buf` being true. It is recommended that implementations
        /// only write data to `buf` instead of reading its contents.
        ///
        /// # Errors
        ///
        /// If this function encounters an error of the kind
        /// [`ErrorKind::Interrupted`] then the error is ignored and the operation
        /// will continue.
        ///
        /// If this function encounters an "end of file" before completely filling
        /// the buffer, it returns an error of the kind [`ErrorKind::UnexpectedEof`].
        /// The contents of `buf` are unspecified in this case.
        ///
        /// If any other read error is encountered then this function immediately
        /// returns. The contents of `buf` are unspecified in this case.
        ///
        /// If this function returns an error, it is unspecified how many bytes it
        /// has read, but it will never read more than would be necessary to
        /// completely fill the buffer.
        ///
        /// # Examples
        ///
        /// [`File`]s implement `Read`:
        ///
        /// [`File`]: ../fs/struct.File.html
        /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
        /// [`ErrorKind::UnexpectedEof`]: ../../std/io/enum.ErrorKind.html#variant.UnexpectedEof
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///     let mut buffer = [0; 10];
        ///
        ///     // read exactly 10 bytes
        ///     f.read_exact(&mut buffer)?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "read_exact", since = "1.6.0")]
        fn read_exact(&mut self, mut buf: &mut [u8]) -> Result<()> {
            while !buf.is_empty() {
                match self.read(buf) {
                    Ok(0) => break,
                    Ok(n) => { let tmp = buf; buf = &mut tmp[n..]; }
                    Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
                    Err(e) => return Err(e),
                }
            }
            if !buf.is_empty() {
                Err(Error::new(ErrorKind::UnexpectedEof,
                               "failed to fill whole buffer"))
            } else {
                Ok(())
            }
        }

        /// Creates a "by reference" adaptor for this instance of `Read`.
        ///
        /// The returned adaptor also implements `Read` and will simply borrow this
        /// current reader.
        ///
        /// # Examples
        ///
        /// [`File`][file]s implement `Read`:
        ///
        /// [file]: ../fs/struct.File.html
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::Read;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///     let mut buffer = Vec::new();
        ///     let mut other_buffer = Vec::new();
        ///
        ///     {
        ///         let reference = f.by_ref();
        ///
        ///         // read at most 5 bytes
        ///         reference.take(5).read_to_end(&mut buffer)?;
        ///
        ///     } // drop our &mut reference so we can use f again
        ///
        ///     // original file still usable, read the rest
        ///     f.read_to_end(&mut other_buffer)?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn by_ref(&mut self) -> &mut Self where Self: Sized { self }

        /// Transforms this `Read` instance to an [`Iterator`] over its bytes.
        ///
        /// The returned type implements [`Iterator`] where the `Item` is
        /// [`Result`]`<`[`u8`]`, `[`io::Error`]`>`.
        /// The yielded item is [`Ok`] if a byte was successfully read and [`Err`]
        /// otherwise. EOF is mapped to returning [`None`] from this iterator.
        ///
        /// # Examples
        ///
        /// [`File`][file]s implement `Read`:
        ///
        /// [file]: ../fs/struct.File.html
        /// [`Iterator`]: ../../std/iter/trait.Iterator.html
        /// [`Result`]: ../../std/result/enum.Result.html
        /// [`io::Error`]: ../../std/io/struct.Error.html
        /// [`u8`]: ../../std/primitive.u8.html
        /// [`Ok`]: ../../std/result/enum.Result.html#variant.Ok
        /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
        /// [`None`]: ../../std/option/enum.Option.html#variant.None
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///
        ///     for byte in f.bytes() {
        ///         println!("{}", byte.unwrap());
        ///     }
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn bytes(self) -> Bytes<Self> where Self: Sized {
            Bytes { inner: self }
        }

        /// Creates an adaptor which will chain this stream with another.
        ///
        /// The returned `Read` instance will first read all bytes from this object
        /// until EOF is encountered. Afterwards the output is equivalent to the
        /// output of `next`.
        ///
        /// # Examples
        ///
        /// [`File`][file]s implement `Read`:
        ///
        /// [file]: ../fs/struct.File.html
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f1 = File::open("foo.txt")?;
        ///     let mut f2 = File::open("bar.txt")?;
        ///
        ///     let mut handle = f1.chain(f2);
        ///     let mut buffer = String::new();
        ///
        ///     // read the value into a String. We could use any Read method here,
        ///     // this is just one example.
        ///     handle.read_to_string(&mut buffer)?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn chain<R: Read>(self, next: R) -> Chain<Self, R> where Self: Sized {
            Chain { first: self, second: next, done_first: false }
        }

        /// Creates an adaptor which will read at most `limit` bytes from it.
        ///
        /// This function returns a new instance of `Read` which will read at most
        /// `limit` bytes, after which it will always return EOF ([`Ok(0)`]). Any
        /// read errors will not count towards the number of bytes read and future
        /// calls to [`read()`] may succeed.
        ///
        /// # Examples
        ///
        /// [`File`]s implement `Read`:
        ///
        /// [`File`]: ../fs/struct.File.html
        /// [`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok
        /// [`read()`]: trait.Read.html#tymethod.read
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut f = File::open("foo.txt")?;
        ///     let mut buffer = [0; 5];
        ///
        ///     // read at most five bytes
        ///     let mut handle = f.take(5);
        ///
        ///     handle.read(&mut buffer)?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn take(self, limit: u64) -> Take<Self> where Self: Sized {
            Take { inner: self, limit: limit }
        }
    }

    /// A type used to conditionally initialize buffers passed to `Read` methods.
    #[unstable(feature = "read_initializer", issue = "42788")]
    #[derive(Debug)]
    pub struct Initializer(bool);

    impl Initializer {
        /// Returns a new `Initializer` which will zero out buffers.
        #[unstable(feature = "read_initializer", issue = "42788")]
        #[inline]
        pub fn zeroing() -> Initializer {
            Initializer(true)
        }

        /// Returns a new `Initializer` which will not zero out buffers.
        ///
        /// # Safety
        ///
        /// This may only be called by `Read`ers which guarantee that they will not
        /// read from buffers passed to `Read` methods, and that the return value of
        /// the method accurately reflects the number of bytes that have been
        /// written to the head of the buffer.
        #[unstable(feature = "read_initializer", issue = "42788")]
        #[inline]
        pub unsafe fn nop() -> Initializer {
            Initializer(false)
        }

        /// Indicates if a buffer should be initialized.
        #[unstable(feature = "read_initializer", issue = "42788")]
        #[inline]
        pub fn should_initialize(&self) -> bool {
            self.0
        }

        /// Initializes a buffer if necessary.
        #[unstable(feature = "read_initializer", issue = "42788")]
        #[inline]
        pub fn initialize(&self, buf: &mut [u8]) {
            if self.should_initialize() {
                unsafe { ptr::write_bytes(buf.as_mut_ptr(), 0, buf.len()) }
            }
        }
    }

    /// A trait for objects which are byte-oriented sinks.
    ///
    /// Implementors of the `Write` trait are sometimes called 'writers'.
    ///
    /// Writers are defined by two required methods, [`write`] and [`flush`]:
    ///
    /// * The [`write`] method will attempt to write some data into the object,
    ///   returning how many bytes were successfully written.
    ///
    /// * The [`flush`] method is useful for adaptors and explicit buffers
    ///   themselves for ensuring that all buffered data has been pushed out to the
    ///   'true sink'.
    ///
    /// Writers are intended to be composable with one another. Many implementors
    /// throughout [`std::io`] take and provide types which implement the `Write`
    /// trait.
    ///
    /// [`write`]: #tymethod.write
    /// [`flush`]: #tymethod.flush
    /// [`std::io`]: index.html
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use std::io::prelude::*;
    /// use std::fs::File;
    ///
    /// fn main() -> std::io::Result<()> {
    ///     let mut buffer = File::create("foo.txt")?;
    ///
    ///     buffer.write(b"some bytes")?;
    ///     Ok(())
    /// }
    /// ```
    #[stable(feature = "rust1", since = "1.0.0")]
    #[doc(spotlight)]
    pub trait Write {
        /// Write a buffer into this writer, returning how many bytes were written.
        ///
        /// This function will attempt to write the entire contents of `buf`, but
        /// the entire write may not succeed, or the write may also generate an
        /// error. A call to `write` represents *at most one* attempt to write to
        /// any wrapped object.
        ///
        /// Calls to `write` are not guaranteed to block waiting for data to be
        /// written, and a write which would otherwise block can be indicated through
        /// an [`Err`] variant.
        ///
        /// If the return value is [`Ok(n)`] then it must be guaranteed that
        /// `0 <= n <= buf.len()`. A return value of `0` typically means that the
        /// underlying object is no longer able to accept bytes and will likely not
        /// be able to in the future as well, or that the buffer provided is empty.
        ///
        /// # Errors
        ///
        /// Each call to `write` may generate an I/O error indicating that the
        /// operation could not be completed. If an error is returned then no bytes
        /// in the buffer were written to this writer.
        ///
        /// It is **not** considered an error if the entire buffer could not be
        /// written to this writer.
        ///
        /// An error of the [`ErrorKind::Interrupted`] kind is non-fatal and the
        /// write operation should be retried if there is nothing else to do.
        ///
        /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
        /// [`Ok(n)`]:  ../../std/result/enum.Result.html#variant.Ok
        /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> std::io::Result<()> {
        ///     let mut buffer = File::create("foo.txt")?;
        ///
        ///     // Writes some prefix of the byte string, not necessarily all of it.
        ///     buffer.write(b"some bytes")?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn write(&mut self, buf: &[u8]) -> Result<usize>;

        /// Flush this output stream, ensuring that all intermediately buffered
        /// contents reach their destination.
        ///
        /// # Errors
        ///
        /// It is considered an error if not all bytes could be written due to
        /// I/O errors or EOF being reached.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::prelude::*;
        /// use std::io::BufWriter;
        /// use std::fs::File;
        ///
        /// fn main() -> std::io::Result<()> {
        ///     let mut buffer = BufWriter::new(File::create("foo.txt")?);
        ///
        ///     buffer.write(b"some bytes")?;
        ///     buffer.flush()?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn flush(&mut self) -> Result<()>;

        /// Attempts to write an entire buffer into this writer.
        ///
        /// This method will continuously call [`write`] until there is no more data
        /// to be written or an error of non-[`ErrorKind::Interrupted`] kind is
        /// returned. This method will not return until the entire buffer has been
        /// successfully written or such an error occurs. The first error that is
        /// not of [`ErrorKind::Interrupted`] kind generated from this method will be
        /// returned.
        ///
        /// # Errors
        ///
        /// This function will return the first error of
        /// non-[`ErrorKind::Interrupted`] kind that [`write`] returns.
        ///
        /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
        /// [`write`]: #tymethod.write
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> std::io::Result<()> {
        ///     let mut buffer = File::create("foo.txt")?;
        ///
        ///     buffer.write_all(b"some bytes")?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn write_all(&mut self, mut buf: &[u8]) -> Result<()> {
            while !buf.is_empty() {
                match self.write(buf) {
                    Ok(0) => return Err(Error::new(ErrorKind::WriteZero,
                                                   "failed to write whole buffer")),
                    Ok(n) => buf = &buf[n..],
                    Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
                    Err(e) => return Err(e),
                }
            }
            Ok(())
        }

        /// Writes a formatted string into this writer, returning any error
        /// encountered.
        ///
        /// This method is primarily used to interface with the
        /// [`format_args!`][formatargs] macro, but it is rare that this should
        /// explicitly be called. The [`write!`][write] macro should be favored to
        /// invoke this method instead.
        ///
        /// [formatargs]: ../macro.format_args.html
        /// [write]: ../macro.write.html
        ///
        /// This function internally uses the [`write_all`][writeall] method on
        /// this trait and hence will continuously write data so long as no errors
        /// are received. This also means that partial writes are not indicated in
        /// this signature.
        ///
        /// [writeall]: #method.write_all
        ///
        /// # Errors
        ///
        /// This function will return any I/O error reported while formatting.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> std::io::Result<()> {
        ///     let mut buffer = File::create("foo.txt")?;
        ///
        ///     // this call
        ///     write!(buffer, "{:.*}", 2, 1.234567)?;
        ///     // turns into this:
        ///     buffer.write_fmt(format_args!("{:.*}", 2, 1.234567))?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn write_fmt(&mut self, fmt: fmt::Arguments) -> Result<()> {
            // Create a shim which translates a Write to a fmt::Write and saves
            // off I/O errors. instead of discarding them
            struct Adaptor<'a, T: ?Sized + 'a> {
                inner: &'a mut T,
                error: Result<()>,
            }

            impl<'a, T: Write + ?Sized> fmt::Write for Adaptor<'a, T> {
                fn write_str(&mut self, s: &str) -> fmt::Result {
                    match self.inner.write_all(s.as_bytes()) {
                        Ok(()) => Ok(()),
                        Err(e) => {
                            self.error = Err(e);
                            Err(fmt::Error)
                        }
                    }
                }
            }

            let mut output = Adaptor { inner: self, error: Ok(()) };
            match fmt::write(&mut output, fmt) {
                Ok(()) => Ok(()),
                Err(..) => {
                    // check if the error came from the underlying `Write` or not
                    if output.error.is_err() {
                        output.error
                    } else {
                        Err(Error::new(ErrorKind::Other, "formatter error"))
                    }
                }
            }
        }

        /// Creates a "by reference" adaptor for this instance of `Write`.
        ///
        /// The returned adaptor also implements `Write` and will simply borrow this
        /// current writer.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::Write;
        /// use std::fs::File;
        ///
        /// fn main() -> std::io::Result<()> {
        ///     let mut buffer = File::create("foo.txt")?;
        ///
        ///     let reference = buffer.by_ref();
        ///
        ///     // we can use reference just like our original buffer
        ///     reference.write_all(b"some bytes")?;
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn by_ref(&mut self) -> &mut Self where Self: Sized { self }
    }

    /// The `Seek` trait provides a cursor which can be moved within a stream of
    /// bytes.
    ///
    /// The stream typically has a fixed size, allowing seeking relative to either
    /// end or the current offset.
    ///
    /// # Examples
    ///
    /// [`File`][file]s implement `Seek`:
    ///
    /// [file]: ../fs/struct.File.html
    ///
    /// ```no_run
    /// use std::io;
    /// use std::io::prelude::*;
    /// use std::fs::File;
    /// use std::io::SeekFrom;
    ///
    /// fn main() -> io::Result<()> {
    ///     let mut f = File::open("foo.txt")?;
    ///
    ///     // move the cursor 42 bytes from the start of the file
    ///     f.seek(SeekFrom::Start(42))?;
    ///     Ok(())
    /// }
    /// ```
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait Seek {
        /// Seek to an offset, in bytes, in a stream.
        ///
        /// A seek beyond the end of a stream is allowed, but behavior is defined
        /// by the implementation.
        ///
        /// If the seek operation completed successfully,
        /// this method returns the new position from the start of the stream.
        /// That position can be used later with [`SeekFrom::Start`].
        ///
        /// # Errors
        ///
        /// Seeking to a negative offset is considered an error.
        ///
        /// [`SeekFrom::Start`]: enum.SeekFrom.html#variant.Start
        #[stable(feature = "rust1", since = "1.0.0")]
        fn seek(&mut self, pos: SeekFrom) -> Result<u64>;
    }

    /// Enumeration of possible methods to seek within an I/O object.
    ///
    /// It is used by the [`Seek`] trait.
    ///
    /// [`Seek`]: trait.Seek.html
    #[derive(Copy, PartialEq, Eq, Clone, Debug)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub enum SeekFrom {
        /// Set the offset to the provided number of bytes.
        #[stable(feature = "rust1", since = "1.0.0")]
        Start(#[stable(feature = "rust1", since = "1.0.0")] u64),

        /// Set the offset to the size of this object plus the specified number of
        /// bytes.
        ///
        /// It is possible to seek beyond the end of an object, but it's an error to
        /// seek before byte 0.
        #[stable(feature = "rust1", since = "1.0.0")]
        End(#[stable(feature = "rust1", since = "1.0.0")] i64),

        /// Set the offset to the current position plus the specified number of
        /// bytes.
        ///
        /// It is possible to seek beyond the end of an object, but it's an error to
        /// seek before byte 0.
        #[stable(feature = "rust1", since = "1.0.0")]
        Current(#[stable(feature = "rust1", since = "1.0.0")] i64),
    }

    fn read_until<R: BufRead + ?Sized>(r: &mut R, delim: u8, buf: &mut Vec<u8>)
                                       -> Result<usize> {
        let mut read = 0;
        loop {
            let (done, used) = {
                let available = match r.fill_buf() {
                    Ok(n) => n,
                    Err(ref e) if e.kind() == ErrorKind::Interrupted => continue,
                    Err(e) => return Err(e)
                };
                match memchr::memchr(delim, available) {
                    Some(i) => {
                        buf.extend_from_slice(&available[..=i]);
                        (true, i + 1)
                    }
                    None => {
                        buf.extend_from_slice(available);
                        (false, available.len())
                    }
                }
            };
            r.consume(used);
            read += used;
            if done || used == 0 {
                return Ok(read);
            }
        }
    }

    /// A `BufRead` is a type of `Read`er which has an internal buffer, allowing it
    /// to perform extra ways of reading.
    ///
    /// For example, reading line-by-line is inefficient without using a buffer, so
    /// if you want to read by line, you'll need `BufRead`, which includes a
    /// [`read_line`] method as well as a [`lines`] iterator.
    ///
    /// # Examples
    ///
    /// A locked standard input implements `BufRead`:
    ///
    /// ```no_run
    /// use std::io;
    /// use std::io::prelude::*;
    ///
    /// let stdin = io::stdin();
    /// for line in stdin.lock().lines() {
    ///     println!("{}", line.unwrap());
    /// }
    /// ```
    ///
    /// If you have something that implements [`Read`], you can use the [`BufReader`
    /// type][`BufReader`] to turn it into a `BufRead`.
    ///
    /// For example, [`File`] implements [`Read`], but not `BufRead`.
    /// [`BufReader`] to the rescue!
    ///
    /// [`BufReader`]: struct.BufReader.html
    /// [`File`]: ../fs/struct.File.html
    /// [`read_line`]: #method.read_line
    /// [`lines`]: #method.lines
    /// [`Read`]: trait.Read.html
    ///
    /// ```no_run
    /// use std::io::{self, BufReader};
    /// use std::io::prelude::*;
    /// use std::fs::File;
    ///
    /// fn main() -> io::Result<()> {
    ///     let f = File::open("foo.txt")?;
    ///     let f = BufReader::new(f);
    ///
    ///     for line in f.lines() {
    ///         println!("{}", line.unwrap());
    ///     }
    ///
    ///     Ok(())
    /// }
    /// ```
    ///
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait BufRead: Read {
        /// Returns the contents of the internal buffer, filling it with more data
        /// from the inner reader if it is empty.
        ///
        /// This function is a lower-level call. It needs to be paired with the
        /// [`consume`] method to function properly. When calling this
        /// method, none of the contents will be "read" in the sense that later
        /// calling `read` may return the same contents. As such, [`consume`] must
        /// be called with the number of bytes that are consumed from this buffer to
        /// ensure that the bytes are never returned twice.
        ///
        /// [`consume`]: #tymethod.consume
        ///
        /// An empty buffer returned indicates that the stream has reached EOF.
        ///
        /// # Errors
        ///
        /// This function will return an I/O error if the underlying reader was
        /// read, but returned an error.
        ///
        /// # Examples
        ///
        /// A locked standard input implements `BufRead`:
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        ///
        /// let stdin = io::stdin();
        /// let mut stdin = stdin.lock();
        ///
        /// // we can't have two `&mut` references to `stdin`, so use a block
        /// // to end the borrow early.
        /// let length = {
        ///     let buffer = stdin.fill_buf().unwrap();
        ///
        ///     // work with buffer
        ///     println!("{:?}", buffer);
        ///
        ///     buffer.len()
        /// };
        ///
        /// // ensure the bytes we worked with aren't returned again later
        /// stdin.consume(length);
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn fill_buf(&mut self) -> Result<&[u8]>;

        /// Tells this buffer that `amt` bytes have been consumed from the buffer,
        /// so they should no longer be returned in calls to `read`.
        ///
        /// This function is a lower-level call. It needs to be paired with the
        /// [`fill_buf`] method to function properly. This function does
        /// not perform any I/O, it simply informs this object that some amount of
        /// its buffer, returned from [`fill_buf`], has been consumed and should
        /// no longer be returned. As such, this function may do odd things if
        /// [`fill_buf`] isn't called before calling it.
        ///
        /// The `amt` must be `<=` the number of bytes in the buffer returned by
        /// [`fill_buf`].
        ///
        /// # Examples
        ///
        /// Since `consume()` is meant to be used with [`fill_buf`],
        /// that method's example includes an example of `consume()`.
        ///
        /// [`fill_buf`]: #tymethod.fill_buf
        #[stable(feature = "rust1", since = "1.0.0")]
        fn consume(&mut self, amt: usize);

        /// Read all bytes into `buf` until the delimiter `byte` or EOF is reached.
        ///
        /// This function will read bytes from the underlying stream until the
        /// delimiter or EOF is found. Once found, all bytes up to, and including,
        /// the delimiter (if found) will be appended to `buf`.
        ///
        /// If successful, this function will return the total number of bytes read.
        ///
        /// # Errors
        ///
        /// This function will ignore all instances of [`ErrorKind::Interrupted`] and
        /// will otherwise return any errors returned by [`fill_buf`].
        ///
        /// If an I/O error is encountered then all bytes read so far will be
        /// present in `buf` and its length will have been adjusted appropriately.
        ///
        /// [`fill_buf`]: #tymethod.fill_buf
        /// [`ErrorKind::Interrupted`]: enum.ErrorKind.html#variant.Interrupted
        ///
        /// # Examples
        ///
        /// [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In
        /// this example, we use [`Cursor`] to read all the bytes in a byte slice
        /// in hyphen delimited segments:
        ///
        /// [`Cursor`]: struct.Cursor.html
        ///
        /// ```
        /// use std::io::{self, BufRead};
        ///
        /// let mut cursor = io::Cursor::new(b"lorem-ipsum");
        /// let mut buf = vec![];
        ///
        /// // cursor is at 'l'
        /// let num_bytes = cursor.read_until(b'-', &mut buf)
        ///     .expect("reading from cursor won't fail");
        /// assert_eq!(num_bytes, 6);
        /// assert_eq!(buf, b"lorem-");
        /// buf.clear();
        ///
        /// // cursor is at 'i'
        /// let num_bytes = cursor.read_until(b'-', &mut buf)
        ///     .expect("reading from cursor won't fail");
        /// assert_eq!(num_bytes, 5);
        /// assert_eq!(buf, b"ipsum");
        /// buf.clear();
        ///
        /// // cursor is at EOF
        /// let num_bytes = cursor.read_until(b'-', &mut buf)
        ///     .expect("reading from cursor won't fail");
        /// assert_eq!(num_bytes, 0);
        /// assert_eq!(buf, b"");
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize> {
            read_until(self, byte, buf)
        }

        /// Read all bytes until a newline (the 0xA byte) is reached, and append
        /// them to the provided buffer.
        ///
        /// This function will read bytes from the underlying stream until the
        /// newline delimiter (the 0xA byte) or EOF is found. Once found, all bytes
        /// up to, and including, the delimiter (if found) will be appended to
        /// `buf`.
        ///
        /// If successful, this function will return the total number of bytes read.
        ///
        /// An empty buffer returned indicates that the stream has reached EOF.
        ///
        /// # Errors
        ///
        /// This function has the same error semantics as [`read_until`] and will
        /// also return an error if the read bytes are not valid UTF-8. If an I/O
        /// error is encountered then `buf` may contain some bytes already read in
        /// the event that all data read so far was valid UTF-8.
        ///
        /// [`read_until`]: #method.read_until
        ///
        /// # Examples
        ///
        /// [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In
        /// this example, we use [`Cursor`] to read all the lines in a byte slice:
        ///
        /// [`Cursor`]: struct.Cursor.html
        ///
        /// ```
        /// use std::io::{self, BufRead};
        ///
        /// let mut cursor = io::Cursor::new(b"foo\nbar");
        /// let mut buf = String::new();
        ///
        /// // cursor is at 'f'
        /// let num_bytes = cursor.read_line(&mut buf)
        ///     .expect("reading from cursor won't fail");
        /// assert_eq!(num_bytes, 4);
        /// assert_eq!(buf, "foo\n");
        /// buf.clear();
        ///
        /// // cursor is at 'b'
        /// let num_bytes = cursor.read_line(&mut buf)
        ///     .expect("reading from cursor won't fail");
        /// assert_eq!(num_bytes, 3);
        /// assert_eq!(buf, "bar");
        /// buf.clear();
        ///
        /// // cursor is at EOF
        /// let num_bytes = cursor.read_line(&mut buf)
        ///     .expect("reading from cursor won't fail");
        /// assert_eq!(num_bytes, 0);
        /// assert_eq!(buf, "");
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn read_line(&mut self, buf: &mut String) -> Result<usize> {
            // Note that we are not calling the `.read_until` method here, but
            // rather our hardcoded implementation. For more details as to why, see
            // the comments in `read_to_end`.
            append_to_string(buf, |b| read_until(self, b'\n', b))
        }

        /// Returns an iterator over the contents of this reader split on the byte
        /// `byte`.
        ///
        /// The iterator returned from this function will return instances of
        /// [`io::Result`]`<`[`Vec<u8>`]`>`. Each vector returned will *not* have
        /// the delimiter byte at the end.
        ///
        /// This function will yield errors whenever [`read_until`] would have
        /// also yielded an error.
        ///
        /// [`io::Result`]: type.Result.html
        /// [`Vec<u8>`]: ../vec/struct.Vec.html
        /// [`read_until`]: #method.read_until
        ///
        /// # Examples
        ///
        /// [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In
        /// this example, we use [`Cursor`] to iterate over all hyphen delimited
        /// segments in a byte slice
        ///
        /// [`Cursor`]: struct.Cursor.html
        ///
        /// ```
        /// use std::io::{self, BufRead};
        ///
        /// let cursor = io::Cursor::new(b"lorem-ipsum-dolor");
        ///
        /// let mut split_iter = cursor.split(b'-').map(|l| l.unwrap());
        /// assert_eq!(split_iter.next(), Some(b"lorem".to_vec()));
        /// assert_eq!(split_iter.next(), Some(b"ipsum".to_vec()));
        /// assert_eq!(split_iter.next(), Some(b"dolor".to_vec()));
        /// assert_eq!(split_iter.next(), None);
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        fn split(self, byte: u8) -> Split<Self> where Self: Sized {
            Split { buf: self, delim: byte }
        }

        /// Returns an iterator over the lines of this reader.
        ///
        /// The iterator returned from this function will yield instances of
        /// [`io::Result`]`<`[`String`]`>`. Each string returned will *not* have a newline
        /// byte (the 0xA byte) or CRLF (0xD, 0xA bytes) at the end.
        ///
        /// [`io::Result`]: type.Result.html
        /// [`String`]: ../string/struct.String.html
        ///
        /// # Examples
        ///
        /// [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In
        /// this example, we use [`Cursor`] to iterate over all the lines in a byte
        /// slice.
        ///
        /// [`Cursor`]: struct.Cursor.html
        ///
        /// ```
        /// use std::io::{self, BufRead};
        ///
        /// let cursor = io::Cursor::new(b"lorem\nipsum\r\ndolor");
        ///
        /// let mut lines_iter = cursor.lines().map(|l| l.unwrap());
        /// assert_eq!(lines_iter.next(), Some(String::from("lorem")));
        /// assert_eq!(lines_iter.next(), Some(String::from("ipsum")));
        /// assert_eq!(lines_iter.next(), Some(String::from("dolor")));
        /// assert_eq!(lines_iter.next(), None);
        /// ```
        ///
        /// # Errors
        ///
        /// Each line of the iterator has the same error semantics as [`BufRead::read_line`].
        ///
        /// [`BufRead::read_line`]: trait.BufRead.html#method.read_line
        #[stable(feature = "rust1", since = "1.0.0")]
        fn lines(self) -> Lines<Self> where Self: Sized {
            Lines { buf: self }
        }
    }

    /// Adaptor to chain together two readers.
    ///
    /// This struct is generally created by calling [`chain`] on a reader.
    /// Please see the documentation of [`chain`] for more details.
    ///
    /// [`chain`]: trait.Read.html#method.chain
    #[stable(feature = "rust1", since = "1.0.0")]
    pub struct Chain<T, U> {
        first: T,
        second: U,
        done_first: bool,
    }

    impl<T, U> Chain<T, U> {
        /// Consumes the `Chain`, returning the wrapped readers.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut foo_file = File::open("foo.txt")?;
        ///     let mut bar_file = File::open("bar.txt")?;
        ///
        ///     let chain = foo_file.chain(bar_file);
        ///     let (foo_file, bar_file) = chain.into_inner();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "more_io_inner_methods", since = "1.20.0")]
        pub fn into_inner(self) -> (T, U) {
            (self.first, self.second)
        }

        /// Gets references to the underlying readers in this `Chain`.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut foo_file = File::open("foo.txt")?;
        ///     let mut bar_file = File::open("bar.txt")?;
        ///
        ///     let chain = foo_file.chain(bar_file);
        ///     let (foo_file, bar_file) = chain.get_ref();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "more_io_inner_methods", since = "1.20.0")]
        pub fn get_ref(&self) -> (&T, &U) {
            (&self.first, &self.second)
        }

        /// Gets mutable references to the underlying readers in this `Chain`.
        ///
        /// Care should be taken to avoid modifying the internal I/O state of the
        /// underlying readers as doing so may corrupt the internal state of this
        /// `Chain`.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut foo_file = File::open("foo.txt")?;
        ///     let mut bar_file = File::open("bar.txt")?;
        ///
        ///     let mut chain = foo_file.chain(bar_file);
        ///     let (foo_file, bar_file) = chain.get_mut();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "more_io_inner_methods", since = "1.20.0")]
        pub fn get_mut(&mut self) -> (&mut T, &mut U) {
            (&mut self.first, &mut self.second)
        }
    }

    #[stable(feature = "std_debug", since = "1.16.0")]
    impl<T: fmt::Debug, U: fmt::Debug> fmt::Debug for Chain<T, U> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.debug_struct("Chain")
                .field("t", &self.first)
                .field("u", &self.second)
                .finish()
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: Read, U: Read> Read for Chain<T, U> {
        fn read(&mut self, buf: &mut [u8]) -> Result<usize> {
            if !self.done_first {
                match self.first.read(buf)? {
                    0 if buf.len() != 0 => { self.done_first = true; }
                    n => return Ok(n),
                }
            }
            self.second.read(buf)
        }

        unsafe fn initializer(&self) -> Initializer {
            let initializer = self.first.initializer();
            if initializer.should_initialize() {
                initializer
            } else {
                self.second.initializer()
            }
        }
    }

    #[stable(feature = "chain_bufread", since = "1.9.0")]
    impl<T: BufRead, U: BufRead> BufRead for Chain<T, U> {
        fn fill_buf(&mut self) -> Result<&[u8]> {
            if !self.done_first {
                match self.first.fill_buf()? {
                    buf if buf.len() == 0 => { self.done_first = true; }
                    buf => return Ok(buf),
                }
            }
            self.second.fill_buf()
        }

        fn consume(&mut self, amt: usize) {
            if !self.done_first {
                self.first.consume(amt)
            } else {
                self.second.consume(amt)
            }
        }
    }

    /// Reader adaptor which limits the bytes read from an underlying reader.
    ///
    /// This struct is generally created by calling [`take`] on a reader.
    /// Please see the documentation of [`take`] for more details.
    ///
    /// [`take`]: trait.Read.html#method.take
    #[stable(feature = "rust1", since = "1.0.0")]
    #[derive(Debug)]
    pub struct Take<T> {
        inner: T,
        limit: u64,
    }

    impl<T> Take<T> {
        /// Returns the number of bytes that can be read before this instance will
        /// return EOF.
        ///
        /// # Note
        ///
        /// This instance may reach `EOF` after reading fewer bytes than indicated by
        /// this method if the underlying [`Read`] instance reaches EOF.
        ///
        /// [`Read`]: ../../std/io/trait.Read.html
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let f = File::open("foo.txt")?;
        ///
        ///     // read at most five bytes
        ///     let handle = f.take(5);
        ///
        ///     println!("limit: {}", handle.limit());
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        pub fn limit(&self) -> u64 { self.limit }

        /// Sets the number of bytes that can be read before this instance will
        /// return EOF. This is the same as constructing a new `Take` instance, so
        /// the amount of bytes read and the previous limit value don't matter when
        /// calling this method.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let f = File::open("foo.txt")?;
        ///
        ///     // read at most five bytes
        ///     let mut handle = f.take(5);
        ///     handle.set_limit(10);
        ///
        ///     assert_eq!(handle.limit(), 10);
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "take_set_limit", since = "1.27.0")]
        pub fn set_limit(&mut self, limit: u64) {
            self.limit = limit;
        }

        /// Consumes the `Take`, returning the wrapped reader.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut file = File::open("foo.txt")?;
        ///
        ///     let mut buffer = [0; 5];
        ///     let mut handle = file.take(5);
        ///     handle.read(&mut buffer)?;
        ///
        ///     let file = handle.into_inner();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "io_take_into_inner", since = "1.15.0")]
        pub fn into_inner(self) -> T {
            self.inner
        }

        /// Gets a reference to the underlying reader.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut file = File::open("foo.txt")?;
        ///
        ///     let mut buffer = [0; 5];
        ///     let mut handle = file.take(5);
        ///     handle.read(&mut buffer)?;
        ///
        ///     let file = handle.get_ref();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "more_io_inner_methods", since = "1.20.0")]
        pub fn get_ref(&self) -> &T {
            &self.inner
        }

        /// Gets a mutable reference to the underlying reader.
        ///
        /// Care should be taken to avoid modifying the internal I/O state of the
        /// underlying reader as doing so may corrupt the internal limit of this
        /// `Take`.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io;
        /// use std::io::prelude::*;
        /// use std::fs::File;
        ///
        /// fn main() -> io::Result<()> {
        ///     let mut file = File::open("foo.txt")?;
        ///
        ///     let mut buffer = [0; 5];
        ///     let mut handle = file.take(5);
        ///     handle.read(&mut buffer)?;
        ///
        ///     let file = handle.get_mut();
        ///     Ok(())
        /// }
        /// ```
        #[stable(feature = "more_io_inner_methods", since = "1.20.0")]
        pub fn get_mut(&mut self) -> &mut T {
            &mut self.inner
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: Read> Read for Take<T> {
        fn read(&mut self, buf: &mut [u8]) -> Result<usize> {
            // Don't call into inner reader at all at EOF because it may still block
            if self.limit == 0 {
                return Ok(0);
            }

            let max = cmp::min(buf.len() as u64, self.limit) as usize;
            let n = self.inner.read(&mut buf[..max])?;
            self.limit -= n as u64;
            Ok(n)
        }

        unsafe fn initializer(&self) -> Initializer {
            self.inner.initializer()
        }

        fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize> {
            let reservation_size = cmp::min(self.limit, 32) as usize;

            read_to_end_with_reservation(self, buf, reservation_size)
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<T: BufRead> BufRead for Take<T> {
        fn fill_buf(&mut self) -> Result<&[u8]> {
            // Don't call into inner reader at all at EOF because it may still block
            if self.limit == 0 {
                return Ok(&[]);
            }

            let buf = self.inner.fill_buf()?;
            let cap = cmp::min(buf.len() as u64, self.limit) as usize;
            Ok(&buf[..cap])
        }

        fn consume(&mut self, amt: usize) {
            // Don't let callers reset the limit by passing an overlarge value
            let amt = cmp::min(amt as u64, self.limit) as usize;
            self.limit -= amt as u64;
            self.inner.consume(amt);
        }
    }

    /// An iterator over `u8` values of a reader.
    ///
    /// This struct is generally created by calling [`bytes`] on a reader.
    /// Please see the documentation of [`bytes`] for more details.
    ///
    /// [`bytes`]: trait.Read.html#method.bytes
    #[stable(feature = "rust1", since = "1.0.0")]
    #[derive(Debug)]
    pub struct Bytes<R> {
        inner: R,
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<R: Read> Iterator for Bytes<R> {
        type Item = Result<u8>;

        fn next(&mut self) -> Option<Result<u8>> {
            let mut byte = 0;
            loop {
                return match self.inner.read(slice::from_mut(&mut byte)) {
                    Ok(0) => None,
                    Ok(..) => Some(Ok(byte)),
                    Err(ref e) if e.kind() == ErrorKind::Interrupted => continue,
                    Err(e) => Some(Err(e)),
                };
            }
        }
    }

    /// An iterator over the contents of an instance of `BufRead` split on a
    /// particular byte.
    ///
    /// This struct is generally created by calling [`split`][split] on a
    /// `BufRead`. Please see the documentation of `split()` for more details.
    ///
    /// [split]: trait.BufRead.html#method.split
    #[stable(feature = "rust1", since = "1.0.0")]
    #[derive(Debug)]
    pub struct Split<B> {
        buf: B,
        delim: u8,
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<B: BufRead> Iterator for Split<B> {
        type Item = Result<Vec<u8>>;

        fn next(&mut self) -> Option<Result<Vec<u8>>> {
            let mut buf = Vec::new();
            match self.buf.read_until(self.delim, &mut buf) {
                Ok(0) => None,
                Ok(_n) => {
                    if buf[buf.len() - 1] == self.delim {
                        buf.pop();
                    }
                    Some(Ok(buf))
                }
                Err(e) => Some(Err(e))
            }
        }
    }

    /// An iterator over the lines of an instance of `BufRead`.
    ///
    /// This struct is generally created by calling [`lines`][lines] on a
    /// `BufRead`. Please see the documentation of `lines()` for more details.
    ///
    /// [lines]: trait.BufRead.html#method.lines
    #[stable(feature = "rust1", since = "1.0.0")]
    #[derive(Debug)]
    pub struct Lines<B> {
        buf: B,
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<B: BufRead> Iterator for Lines<B> {
        type Item = Result<String>;

        fn next(&mut self) -> Option<Result<String>> {
            let mut buf = String::new();
            match self.buf.read_line(&mut buf) {
                Ok(0) => None,
                Ok(_n) => {
                    if buf.ends_with("\n") {
                        buf.pop();
                        if buf.ends_with("\r") {
                            buf.pop();
                        }
                    }
                    Some(Ok(buf))
                }
                Err(e) => Some(Err(e))
            }
        }
    }

    #[cfg(test)]
    mod tests {
        use io::prelude::*;
        use io;
        use super::Cursor;
        use test;
        use super::repeat;

        #[test]
        #[cfg_attr(target_os = "emscripten", ignore)]
        fn read_until() {
            let mut buf = Cursor::new(&b"12"[..]);
            let mut v = Vec::new();
            assert_eq!(buf.read_until(b'3', &mut v).unwrap(), 2);
            assert_eq!(v, b"12");

            let mut buf = Cursor::new(&b"1233"[..]);
            let mut v = Vec::new();
            assert_eq!(buf.read_until(b'3', &mut v).unwrap(), 3);
            assert_eq!(v, b"123");
            v.truncate(0);
            assert_eq!(buf.read_until(b'3', &mut v).unwrap(), 1);
            assert_eq!(v, b"3");
            v.truncate(0);
            assert_eq!(buf.read_until(b'3', &mut v).unwrap(), 0);
            assert_eq!(v, []);
        }

        #[test]
        fn split() {
            let buf = Cursor::new(&b"12"[..]);
            let mut s = buf.split(b'3');
            assert_eq!(s.next().unwrap().unwrap(), vec![b'1', b'2']);
            assert!(s.next().is_none());

            let buf = Cursor::new(&b"1233"[..]);
            let mut s = buf.split(b'3');
            assert_eq!(s.next().unwrap().unwrap(), vec![b'1', b'2']);
            assert_eq!(s.next().unwrap().unwrap(), vec![]);
            assert!(s.next().is_none());
        }

        #[test]
        fn read_line() {
            let mut buf = Cursor::new(&b"12"[..]);
            let mut v = String::new();
            assert_eq!(buf.read_line(&mut v).unwrap(), 2);
            assert_eq!(v, "12");

            let mut buf = Cursor::new(&b"12\n\n"[..]);
            let mut v = String::new();
            assert_eq!(buf.read_line(&mut v).unwrap(), 3);
            assert_eq!(v, "12\n");
            v.truncate(0);
            assert_eq!(buf.read_line(&mut v).unwrap(), 1);
            assert_eq!(v, "\n");
            v.truncate(0);
            assert_eq!(buf.read_line(&mut v).unwrap(), 0);
            assert_eq!(v, "");
        }

        #[test]
        fn lines() {
            let buf = Cursor::new(&b"12\r"[..]);
            let mut s = buf.lines();
            assert_eq!(s.next().unwrap().unwrap(), "12\r".to_string());
            assert!(s.next().is_none());

            let buf = Cursor::new(&b"12\r\n\n"[..]);
            let mut s = buf.lines();
            assert_eq!(s.next().unwrap().unwrap(), "12".to_string());
            assert_eq!(s.next().unwrap().unwrap(), "".to_string());
            assert!(s.next().is_none());
        }

        #[test]
        fn read_to_end() {
            let mut c = Cursor::new(&b""[..]);
            let mut v = Vec::new();
            assert_eq!(c.read_to_end(&mut v).unwrap(), 0);
            assert_eq!(v, []);

            let mut c = Cursor::new(&b"1"[..]);
            let mut v = Vec::new();
            assert_eq!(c.read_to_end(&mut v).unwrap(), 1);
            assert_eq!(v, b"1");

            let cap = 1024 * 1024;
            let data = (0..cap).map(|i| (i / 3) as u8).collect::<Vec<_>>();
            let mut v = Vec::new();
            let (a, b) = data.split_at(data.len() / 2);
            assert_eq!(Cursor::new(a).read_to_end(&mut v).unwrap(), a.len());
            assert_eq!(Cursor::new(b).read_to_end(&mut v).unwrap(), b.len());
            assert_eq!(v, data);
        }

        #[test]
        fn read_to_string() {
            let mut c = Cursor::new(&b""[..]);
            let mut v = String::new();
            assert_eq!(c.read_to_string(&mut v).unwrap(), 0);
            assert_eq!(v, "");

            let mut c = Cursor::new(&b"1"[..]);
            let mut v = String::new();
            assert_eq!(c.read_to_string(&mut v).unwrap(), 1);
            assert_eq!(v, "1");

            let mut c = Cursor::new(&b"\xff"[..]);
            let mut v = String::new();
            assert!(c.read_to_string(&mut v).is_err());
        }

        #[test]
        fn read_exact() {
            let mut buf = [0; 4];

            let mut c = Cursor::new(&b""[..]);
            assert_eq!(c.read_exact(&mut buf).unwrap_err().kind(),
                       io::ErrorKind::UnexpectedEof);

            let mut c = Cursor::new(&b"123"[..]).chain(Cursor::new(&b"456789"[..]));
            c.read_exact(&mut buf).unwrap();
            assert_eq!(&buf, b"1234");
            c.read_exact(&mut buf).unwrap();
            assert_eq!(&buf, b"5678");
            assert_eq!(c.read_exact(&mut buf).unwrap_err().kind(),
                       io::ErrorKind::UnexpectedEof);
        }

        #[test]
        fn read_exact_slice() {
            let mut buf = [0; 4];

            let mut c = &b""[..];
            assert_eq!(c.read_exact(&mut buf).unwrap_err().kind(),
                       io::ErrorKind::UnexpectedEof);

            let mut c = &b"123"[..];
            assert_eq!(c.read_exact(&mut buf).unwrap_err().kind(),
                       io::ErrorKind::UnexpectedEof);
            // make sure the optimized (early returning) method is being used
            assert_eq!(&buf, &[0; 4]);

            let mut c = &b"1234"[..];
            c.read_exact(&mut buf).unwrap();
            assert_eq!(&buf, b"1234");

            let mut c = &b"56789"[..];
            c.read_exact(&mut buf).unwrap();
            assert_eq!(&buf, b"5678");
            assert_eq!(c, b"9");
        }

        #[test]
        fn take_eof() {
            struct R;

            impl Read for R {
                fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {
                    Err(io::Error::new(io::ErrorKind::Other, ""))
                }
            }
            impl BufRead for R {
                fn fill_buf(&mut self) -> io::Result<&[u8]> {
                    Err(io::Error::new(io::ErrorKind::Other, ""))
                }
                fn consume(&mut self, _amt: usize) { }
            }

            let mut buf = [0; 1];
            assert_eq!(0, R.take(0).read(&mut buf).unwrap());
            assert_eq!(b"", R.take(0).fill_buf().unwrap());
        }

        fn cmp_bufread<Br1: BufRead, Br2: BufRead>(mut br1: Br1, mut br2: Br2, exp: &[u8]) {
            let mut cat = Vec::new();
            loop {
                let consume = {
                    let buf1 = br1.fill_buf().unwrap();
                    let buf2 = br2.fill_buf().unwrap();
                    let minlen = if buf1.len() < buf2.len() { buf1.len() } else { buf2.len() };
                    assert_eq!(buf1[..minlen], buf2[..minlen]);
                    cat.extend_from_slice(&buf1[..minlen]);
                    minlen
                };
                if consume == 0 {
                    break;
                }
                br1.consume(consume);
                br2.consume(consume);
            }
            assert_eq!(br1.fill_buf().unwrap().len(), 0);
            assert_eq!(br2.fill_buf().unwrap().len(), 0);
            assert_eq!(&cat[..], &exp[..])
        }

        #[test]
        fn chain_bufread() {
            let testdata = b"ABCDEFGHIJKL";
            let chain1 = (&testdata[..3]).chain(&testdata[3..6])
                                         .chain(&testdata[6..9])
                                         .chain(&testdata[9..]);
            let chain2 = (&testdata[..4]).chain(&testdata[4..8])
                                         .chain(&testdata[8..]);
            cmp_bufread(chain1, chain2, &testdata[..]);
        }

        #[test]
        fn chain_zero_length_read_is_not_eof() {
            let a = b"A";
            let b = b"B";
            let mut s = String::new();
            let mut chain = (&a[..]).chain(&b[..]);
            chain.read(&mut []).unwrap();
            chain.read_to_string(&mut s).unwrap();
            assert_eq!("AB", s);
        }

        #[bench]
        #[cfg_attr(target_os = "emscripten", ignore)]
        fn bench_read_to_end(b: &mut test::Bencher) {
            b.iter(|| {
                let mut lr = repeat(1).take(10000000);
                let mut vec = Vec::with_capacity(1024);
                super::read_to_end(&mut lr, &mut vec)
            });
        }
    }

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