Struct NtripConfig 

pub struct NtripConfig {
    pub host: String,
    pub port: u16,
    pub mountpoint: String,
    pub username: Option<String>,
    pub password: Option<String>,
    pub use_tls: bool,
    pub tls_skip_verify: bool,
    pub ntrip_version: NtripVersion,
    pub connection: ConnectionConfig,
    pub proxy: Option<ProxyConfig>,
}

Configuration for an NTRIP client connection.

Fields

host: String

Caster hostname or IP address.

port: u16

Caster port (typically 2101).

mountpoint: String

Mountpoint name.

username: Option<String>

Username for authentication.

password: Option<String>

Password for authentication.

use_tls: bool

Use HTTPS/TLS.

tls_skip_verify: bool

Skip TLS certificate verification (insecure, for testing only).

ntrip_version: NtripVersion

NTRIP protocol version.

connection: ConnectionConfig

Connection configuration.

proxy: Option<ProxyConfig>

HTTP proxy configuration (optional).

Implementations

impl NtripConfig

pub fn new( host: impl Into<String>, port: u16, mountpoint: impl Into<String>, ) -> Self

Create a new configuration with required fields.

pub fn with_credentials( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Set credentials for authentication.

pub fn with_tls(self) -> Self

Enable TLS/HTTPS.

pub fn with_tls_skip_verify(self) -> Self

Skip TLS certificate verification (insecure).

pub fn with_version(self, version: NtripVersion) -> Self

Set NTRIP protocol version.

pub fn with_timeout(self, timeout_secs: u32) -> Self

Set connection timeout.

pub fn with_read_timeout(self, read_timeout_secs: u32) -> Self

Set read timeout.

pub fn with_reconnect(self, max_attempts: u32, delay_ms: u64) -> Self

Set maximum reconnection attempts (0 = disabled).

pub fn without_reconnect(self) -> Self

Disable automatic reconnection.

pub fn with_proxy(self, proxy: ProxyConfig) -> Self

Set HTTP proxy configuration.

When a proxy is configured, the client will connect to the proxy server and use HTTP CONNECT to tunnel the connection to the NTRIP caster.

pub fn with_proxy_from_env(self) -> Self

Configure proxy from environment variables.

Reads $HTTP_PROXY or $http_proxy environment variable. If the variable is not set or invalid, no proxy is configured.

Example

use ntrip_core::NtripConfig;

// Will use proxy from $HTTP_PROXY if set
let config = NtripConfig::new("caster.example.com", 2101, "MOUNT")
    .with_proxy_from_env();

pub fn validate(&self) -> Result<(), Error>

Validate the configuration.

Trait Implementations

impl Clone for NtripConfig

fn clone(&self) -> NtripConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NtripConfig

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

Formats the value using the given formatter.