Struct osmpbf::mmap_blob::Mmap

pub struct Mmap { /* fields omitted */ }

A read-only memory map.

Methods

impl Mmap

pub unsafe fn from_file(file: &File) -> Result<Mmap>

Creates a memory map from a given file.

Safety

The underlying file should not be modified while holding the memory map. See memmap-rs issue 25 for more information on the safety of memory maps.

Example

use osmpbf::*;

let f = std::fs::File::open("tests/test.osm.pbf")?;
let mmap = unsafe { Mmap::from_file(&f)? };

pub unsafe fn from_path<P: AsRef<Path>>(path: P) -> Result<Mmap>

Creates a memory map from a given path.

Safety

The underlying file should not be modified while holding the memory map. See memmap-rs issue 25 for more information on the safety of memory maps.

Example

use osmpbf::*;

let mmap = unsafe { Mmap::from_path("tests/test.osm.pbf")? };

Important traits for MmapBlobReader<'a>

impl<'a> Iterator for MmapBlobReader<'a> type Item = Result<MmapBlob<'a>>;

pub fn blob_iter(&self) -> MmapBlobReader

Returns an iterator over the blobs in this memory map.

Trait Implementations

impl Debug for Mmap

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.