Struct MetadataBuilder 

pub struct MetadataBuilder { /* private fields */ }

Builder for writer metadata.

Implementations

impl MetadataBuilder

pub fn new() -> Self

Creates a builder with MMDB v2 defaults.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().build()?;
assert_eq!(metadata.ip_version, 6);

pub fn database_type(self, value: impl Into<String>) -> Self

Sets the database type identifier.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().database_type("Example-City").build()?;
assert_eq!(metadata.database_type, "Example-City");

pub fn ip_version(self, value: u16) -> Self

Sets the database IP version (4 or 6). Self::build rejects any other value.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().ip_version(4).build()?;
assert_eq!(metadata.ip_version, 4);

pub fn language(self, value: impl Into<String>) -> Self

Adds one advertised language, deduplicating the list.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().language("fr").build()?;
assert!(metadata.languages.contains(&"fr".to_string()));

pub fn languages(self, values: impl IntoIterator<Item = String>) -> Self

Replaces the complete advertised-language list.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().languages(["fr".to_string()]).build()?;
assert_eq!(metadata.languages, vec!["fr".to_string()]);

pub fn description( self, language: impl Into<String>, value: impl Into<String>, ) -> Self

Adds or replaces a localized database description.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().description("en", "Example database").build()?;
assert_eq!(metadata.description["en"], "Example database");

pub fn build_epoch(self, value: u64) -> Self

Overrides the build epoch in seconds since Unix epoch.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().build_epoch(1_700_000_000).build()?;
assert_eq!(metadata.build_epoch, 1_700_000_000);

pub fn build(self) -> Result<Metadata>

Validates the configured fields and produces metadata. Returns Error::InvalidIpVersion for unsupported IP versions or Error::InvalidMetadata for an empty database type.

Examples

use libmaxminddb_rs::MetadataBuilder;
let metadata = MetadataBuilder::new().ip_version(4).build()?;
assert_eq!(metadata.ip_version, 4);

Trait Implementations

impl Clone for MetadataBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataBuilder

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

Formats the value using the given formatter.

impl Default for MetadataBuilder

fn default() -> Self

Returns the “default value” for a type.