Struct WithinOptions 

pub struct WithinOptions { /* private fields */ }

Options for network iteration.

Controls which networks are yielded when iterating over the database with Reader::within() or Reader::networks().

Example

use maxminddb::WithinOptions;

// Default options (skip aliases, skip networks without data, include empty values)
let opts = WithinOptions::default();

// Include aliased networks (IPv4 networks via IPv6 aliases)
let opts = WithinOptions::default().include_aliased_networks();

// Skip empty values and include networks without data
let opts = WithinOptions::default()
    .skip_empty_values()
    .include_networks_without_data();

Implementations

impl WithinOptions

pub fn include_aliased_networks(self) -> Self

Include IPv4 networks multiple times when accessed via IPv6 aliases.

In IPv6 databases, IPv4 networks are stored at ::0/96. However, the same data is accessible through several IPv6 prefixes (e.g., ::ffff:0:0/96 for IPv4-mapped IPv6). By default, these aliases are skipped to avoid yielding the same network multiple times.

When enabled, the iterator will yield these aliased networks.

pub fn include_networks_without_data(self) -> Self

Include networks that have no associated data record.

Some tree nodes point to “no data” (the node_count sentinel). By default these are skipped. When enabled, these networks are yielded and LookupResult::has_data() returns false for them.

pub fn skip_empty_values(self) -> Self

Skip networks whose data is an empty map or empty array.

Some databases store empty maps {} or empty arrays [] for records without meaningful data. This option filters them out.

Trait Implementations

impl Clone for WithinOptions

fn clone(&self) -> WithinOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WithinOptions

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

Formats the value using the given formatter.

impl Default for WithinOptions

fn default() -> WithinOptions

Returns the “default value” for a type.

impl PartialEq for WithinOptions

fn eq(&self, other: &WithinOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for WithinOptions

impl Eq for WithinOptions

impl StructuralPartialEq for WithinOptions