Struct MmdbBuilder 

pub struct MmdbBuilder { /* private fields */ }

Available on crate feature net only.

A builder for MaxMind DB byte images.

Implementations

impl MmdbBuilder

pub fn insert( &mut self, net: IpNet, location: &GeoLocation, ) -> Result<(), MmdbWriteError>

Insert a typed GeoLocation for a network into the database.

For an IPv6 database an IPv4 net is placed in the ::/96 range so the reader’s IPv4-in-IPv6 traversal finds it.

Errors

Returns MmdbWriteError if net’s family does not match the database, it overlaps an existing entry, or the data section grows beyond 4 GiB.

impl MmdbBuilder

pub fn new( ip_version: IpVersion, database_type: impl Into<String>, ) -> MmdbBuilder

Create a builder for a database of the given IpVersion and database_type string (e.g. "GeoLite2-City"). Records are emitted at 32 bits.

pub fn with_languages<I, S>(self, langs: I) -> MmdbBuilder

where I: IntoIterator<Item = S>, S: Into<String>,

Declare the locale codes for which localised data is present.

pub fn with_build_epoch(self, epoch: u64) -> MmdbBuilder

Set the build timestamp (Unix epoch seconds).

pub fn build(&self) -> Result<Vec<u8>, MmdbWriteError>

Serialise the database to a byte vector.

Errors

Returns MmdbWriteError::TooLarge if the resulting tree/data layout exceeds the format’s u32 addressing limit. follow_or_create already bounds the node count, so node_count as u32 here is always exact.

pub fn write_to<W>(&self, w: W) -> Result<(), MmdbWriteError>

where W: Write,

Serialise the database to any writer.

The tree is emitted one 4-byte record at a time, so the writer is internally buffered — callers need not (and should not double-) wrap it.

Errors

Returns MmdbWriteError if the database is too large to encode or the underlying write fails.

pub fn write_to_file( &self, path: impl AsRef<Path>, ) -> Result<(), MmdbWriteError>

Serialise the database to a file at path.

Errors

Returns MmdbWriteError if the database is too large to encode or the file cannot be written.

Trait Implementations

impl Clone for MmdbBuilder

fn clone(&self) -> MmdbBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MmdbBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.