Browse Source

Actually run code in doc tests

Johannes Hofmann 7 years ago
parent
commit
8fd61687b3
4 changed files with 16 additions and 1 deletions
  1. 5
    1
      src/blob.rs
  2. 3
    0
      src/elements.rs
  3. 4
    0
      src/mmap_blob.rs
  4. 4
    0
      src/reader.rs

+ 5
- 1
src/blob.rs View File

150
     ///
150
     ///
151
     /// # Ok(())
151
     /// # Ok(())
152
     /// # }
152
     /// # }
153
+    /// # foo().unwrap();
153
     /// ```
154
     /// ```
154
     pub fn new(reader: R) -> BlobReader<R> {
155
     pub fn new(reader: R) -> BlobReader<R> {
155
         BlobReader {
156
         BlobReader {
174
     /// let reader = BlobReader::from_path("tests/test.osm.pbf")?;
175
     /// let reader = BlobReader::from_path("tests/test.osm.pbf")?;
175
     /// # Ok(())
176
     /// # Ok(())
176
     /// # }
177
     /// # }
178
+    /// # foo().unwrap();
177
     /// ```
179
     /// ```
178
     pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>
180
     pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>
179
     {
181
     {
265
     /// let mut reader = BlobReader::new_seekable(buf_reader)?;
267
     /// let mut reader = BlobReader::new_seekable(buf_reader)?;
266
     /// let first_blob = reader.next().unwrap()?;
268
     /// let first_blob = reader.next().unwrap()?;
267
     ///
269
     ///
268
-    /// assert_eq!(first_blob.offset(), Some(ByteOffset(1)));
270
+    /// assert_eq!(first_blob.offset(), Some(ByteOffset(0)));
269
     /// # Ok(())
271
     /// # Ok(())
270
     /// # }
272
     /// # }
273
+    /// # foo().unwrap();
271
     /// ```
274
     /// ```
272
     pub fn new_seekable(mut reader: R) -> Result<BlobReader<R>> {
275
     pub fn new_seekable(mut reader: R) -> Result<BlobReader<R>> {
273
         let pos = reader.seek(SeekFrom::Current(0))?;
276
         let pos = reader.seek(SeekFrom::Current(0))?;
296
     /// assert_eq!(first_blob.offset(), first_blob_again.offset());
299
     /// assert_eq!(first_blob.offset(), first_blob_again.offset());
297
     /// # Ok(())
300
     /// # Ok(())
298
     /// # }
301
     /// # }
302
+    /// # foo().unwrap();
299
     /// ```
303
     /// ```
300
     pub fn seek(&mut self, pos: ByteOffset) -> Result<()> {
304
     pub fn seek(&mut self, pos: ByteOffset) -> Result<()> {
301
         match self.reader.seek(SeekFrom::Start(pos.0)) {
305
         match self.reader.seek(SeekFrom::Start(pos.0)) {

+ 3
- 0
src/elements.rs View File

68
     ///
68
     ///
69
     /// # Ok(())
69
     /// # Ok(())
70
     /// # }
70
     /// # }
71
+    /// # foo().unwrap();
71
     /// ```
72
     /// ```
72
     pub fn tags(&self) -> TagIter<'a> {
73
     pub fn tags(&self) -> TagIter<'a> {
73
         TagIter {
74
         TagIter {
161
     ///
162
     ///
162
     /// # Ok(())
163
     /// # Ok(())
163
     /// # }
164
     /// # }
165
+    /// # foo().unwrap();
164
     /// ```
166
     /// ```
165
     pub fn tags(&self) -> TagIter<'a> {
167
     pub fn tags(&self) -> TagIter<'a> {
166
         TagIter {
168
         TagIter {
253
     ///
255
     ///
254
     /// # Ok(())
256
     /// # Ok(())
255
     /// # }
257
     /// # }
258
+    /// # foo().unwrap();
256
     /// ```
259
     /// ```
257
     pub fn tags(&self) -> TagIter<'a> {
260
     pub fn tags(&self) -> TagIter<'a> {
258
         TagIter {
261
         TagIter {

+ 4
- 0
src/mmap_blob.rs View File

38
     /// let mmap = unsafe { Mmap::from_file(&f)? };
38
     /// let mmap = unsafe { Mmap::from_file(&f)? };
39
     /// # Ok(())
39
     /// # Ok(())
40
     /// # }
40
     /// # }
41
+    /// # foo().unwrap();
41
     /// ```
42
     /// ```
42
     pub unsafe fn from_file(file: &File) -> Result<Mmap> {
43
     pub unsafe fn from_file(file: &File) -> Result<Mmap> {
43
         memmap::Mmap::map(file)
44
         memmap::Mmap::map(file)
60
     /// let mmap = unsafe { Mmap::from_path("tests/test.osm.pbf")? };
61
     /// let mmap = unsafe { Mmap::from_path("tests/test.osm.pbf")? };
61
     /// # Ok(())
62
     /// # Ok(())
62
     /// # }
63
     /// # }
64
+    /// # foo().unwrap();
63
     /// ```
65
     /// ```
64
     pub unsafe fn from_path<P: AsRef<Path>>(path: P) -> Result<Mmap> {
66
     pub unsafe fn from_path<P: AsRef<Path>>(path: P) -> Result<Mmap> {
65
         let file = File::open(&path)?;
67
         let file = File::open(&path)?;
142
     ///
144
     ///
143
     /// # Ok(())
145
     /// # Ok(())
144
     /// # }
146
     /// # }
147
+    /// # foo().unwrap();
145
     /// ```
148
     /// ```
146
     pub fn new(mmap: &Mmap) -> MmapBlobReader {
149
     pub fn new(mmap: &Mmap) -> MmapBlobReader {
147
         MmapBlobReader {
150
         MmapBlobReader {
172
     ///
175
     ///
173
     /// # Ok(())
176
     /// # Ok(())
174
     /// # }
177
     /// # }
178
+    /// # foo().unwrap();
175
     /// ```
179
     /// ```
176
     pub fn seek(&mut self, pos: ByteOffset) {
180
     pub fn seek(&mut self, pos: ByteOffset) {
177
         self.offset = pos.0 as usize;
181
         self.offset = pos.0 as usize;

+ 4
- 0
src/reader.rs View File

30
     ///
30
     ///
31
     /// # Ok(())
31
     /// # Ok(())
32
     /// # }
32
     /// # }
33
+    /// # foo().unwrap();
33
     /// ```
34
     /// ```
34
     pub fn new(reader: R) -> ElementReader<R> {
35
     pub fn new(reader: R) -> ElementReader<R> {
35
         ElementReader {
36
         ElementReader {
62
     ///
63
     ///
63
     /// # Ok(())
64
     /// # Ok(())
64
     /// # }
65
     /// # }
66
+    /// # foo().unwrap();
65
     /// ```
67
     /// ```
66
     pub fn for_each<F>(self, mut f: F) -> Result<()>
68
     pub fn for_each<F>(self, mut f: F) -> Result<()>
67
         where F: for<'a> FnMut(Element<'a>) {
69
         where F: for<'a> FnMut(Element<'a>) {
114
     /// println!("Number of ways: {}", ways);
116
     /// println!("Number of ways: {}", ways);
115
     /// # Ok(())
117
     /// # Ok(())
116
     /// # }
118
     /// # }
119
+    /// # foo().unwrap();
117
     /// ```
120
     /// ```
118
     pub fn par_map_reduce<MP, RD, ID, T>(self, map_op: MP, identity: ID, reduce_op: RD) -> Result<T>
121
     pub fn par_map_reduce<MP, RD, ID, T>(self, map_op: MP, identity: ID, reduce_op: RD) -> Result<T>
119
         where MP: for<'a> Fn(Element<'a>) -> T + Sync + Send,
122
         where MP: for<'a> Fn(Element<'a>) -> T + Sync + Send,
158
     /// let reader = ElementReader::from_path("tests/test.osm.pbf")?;
161
     /// let reader = ElementReader::from_path("tests/test.osm.pbf")?;
159
     /// # Ok(())
162
     /// # Ok(())
160
     /// # }
163
     /// # }
164
+    /// # foo().unwrap();
161
     /// ```
165
     /// ```
162
     pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>
166
     pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>
163
     {
167
     {