Struct ProxyConfig 

pub struct ProxyConfig { /* private fields */ }

Proxy configuration attached to an McClient.

Quick reference

Constructor	Protocol	Auth	UDP (Bedrock)
socks5	SOCKS5	optional	No
socks5_with_udp	SOCKS5	optional	Yes
http	HTTP CONNECT	optional	No

Examples

use rust_mc_status::proxy::ProxyConfig;

// SOCKS5 — anonymous
let cfg = ProxyConfig::socks5("127.0.0.1:1080");

// SOCKS5 — authenticated
let cfg = ProxyConfig::socks5("proxy.example.com:1080")
    .with_auth("alice", "s3cr3t");

// SOCKS5 — with UDP (Bedrock support)
let cfg = ProxyConfig::socks5_with_udp("10.0.0.1:1080");

// HTTP CONNECT — anonymous
let cfg = ProxyConfig::http("squid.example.com:3128");

// HTTP CONNECT — authenticated
let cfg = ProxyConfig::http("squid.example.com:3128")
    .with_auth("user", "pass");

Implementations

impl ProxyConfig

pub fn socks5(addr: impl AsRef<str>) -> Self

SOCKS5 proxy for Java Edition (TCP) only.

Bedrock pings will fail with ProxyError::UdpUnsupported. Use socks5_with_udp if your proxy supports UDP ASSOCIATE.

pub fn socks5_with_udp(addr: impl AsRef<str>) -> Self

SOCKS5 proxy with UDP ASSOCIATE support (usable for Bedrock too).

pub fn http(addr: impl AsRef<str>) -> Self

HTTP CONNECT proxy (TCP tunnel only).

Compatible with Squid, Nginx, HAProxy, corporate HTTP proxies, and any server that speaks the CONNECT method. UDP is not supported — Bedrock pings will fail with ProxyError::UdpUnsupported.

Authentication is sent as a Proxy-Authorization: Basic ... header.

Example

use rust_mc_status::proxy::ProxyConfig;

let cfg = ProxyConfig::http("squid.corp.example.com:3128");
let cfg = ProxyConfig::http("proxy.example.com:8080")
    .with_auth("user", "pass");

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

Add username/password authentication.

For SOCKS5 this uses username/password sub-negotiation (RFC 1929). For HTTP CONNECT this sends a Proxy-Authorization: Basic header.

pub fn addr(&self) -> &ProxyAddr

pub fn auth(&self) -> Option<&ProxyAuth>

pub fn kind(&self) -> ProxyKind

pub fn udp_support(&self) -> UdpSupport

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyConfig

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

Formats the value using the given formatter.