Struct EdgarConfig 

pub struct EdgarConfig {
    pub user_agent: String,
    pub rate_limit: u32,
    pub timeout: Duration,
    pub base_urls: EdgarUrls,
}

Configuration settings for the Edgar HTTP client.

This struct contains all the settings needed to customize how the Edgar client behaves, including network timeouts, rate limiting, and service endpoints. The default configuration is optimized for general use and SEC.gov compliance, but you can adjust these settings based on your application’s needs.

Examples

Using defaults:

let config = EdgarConfig::default();

Custom configuration:

let config = EdgarConfig::new(
    "research_app/1.0 contact@university.edu",
    5,  // More conservative rate
    Duration::from_secs(45),
    None,  // Use default URLs
);

Fields

user_agent: String

User agent string for HTTP requests (required by SEC)

rate_limit: u32

Rate limit in requests per second (default: 10)

timeout: Duration

HTTP request timeout duration

base_urls: EdgarUrls

Base URLs for different EDGAR services

Implementations

impl EdgarConfig

pub fn new( user_agent: impl Into<String>, rate_limit: u32, timeout: Duration, base_urls: Option<EdgarUrls>, ) -> Self

Creates custom Edgar configuration.

Example

use edgarkit::{EdgarConfig, EdgarUrls};
use std::time::Duration;

let config = EdgarConfig::new(
    "MyApp contact@example.com",
    10,
    Duration::from_secs(30),
    None,
);

Trait Implementations

impl Clone for EdgarConfig

fn clone(&self) -> EdgarConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EdgarConfig

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

Formats the value using the given formatter.

impl Default for EdgarConfig

fn default() -> Self

Returns the “default value” for a type.