Struct Options 

pub struct Options { /* private fields */ }

Options accepted by lookup calls and by the client as defaults.

Every field is optional. Per-call options always override the defaults stored on the client.

Example

use ipwhois::Options;

let opts = Options::new()
    .with_lang("en")
    .with_fields(["success", "country", "city", "flag.emoji"])
    .with_security(true)
    .with_rate(true);

Implementations

impl Options

pub fn new() -> Self

Create an empty options set with no overrides.

pub fn with_lang(self, lang: impl Into<String>) -> Self

Set the response language.

Must be one of crate::SUPPORTED_LANGUAGES. Validated when the call is made — invalid values surface as crate::Error::InvalidArgument, no request is sent.

pub fn with_fields<I, S>(self, fields: I) -> Self

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

Restrict the response to a specific set of fields.

Include "success" if you rely on the success flag for error checking — when fields is set, the API only returns the fields you ask for.

pub fn with_security(self, enabled: bool) -> Self

Toggle the threat-detection (security) block in responses. Requires the Business plan or above.

pub fn with_rate(self, enabled: bool) -> Self

Toggle the rate block in responses (limit, remaining). Requires the Basic plan or above.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl PartialEq for Options

fn eq(&self, other: &Options) -> 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 Eq for Options

impl StructuralPartialEq for Options