Struct vector::config::ProxyConfig

pub struct ProxyConfig {
    pub enabled: bool,
    pub http: Option<String>,
    pub https: Option<String>,
    pub no_proxy: NoProxy,
}

Proxy configuration.

Configure to proxy traffic through an HTTP(S) proxy when making external requests.

Similar to common proxy configuration convention, you can set different proxies to use based on the type of traffic being proxied. You can also set specific hosts that should not be proxied.

Fields

enabled: bool

Enables proxying support.

http: Option<String>

Proxy endpoint to use when proxying HTTP traffic.

Must be a valid URI string.

https: Option<String>

Proxy endpoint to use when proxying HTTPS traffic.

Must be a valid URI string.

no_proxy: NoProxy

A list of hosts to avoid proxying.

Multiple patterns are allowed:

Pattern	Example match
Domain names	example.com matches requests to example.com
Wildcard domains	.example.com matches requests to example.com and its subdomains
IP addresses	127.0.0.1 matches requests to 127.0.0.1
CIDR blocks	192.168.0.0/16 matches requests to any IP addresses in this range
Splat	* matches all hosts

Implementations

impl ProxyConfig

pub fn from_env() -> ProxyConfig

pub fn merge_with_env( global: &ProxyConfig, component: &ProxyConfig, ) -> ProxyConfig

pub fn merge(&self, other: &ProxyConfig) -> ProxyConfig

pub fn configure<C>( &self, connector: &mut ProxyConnector<C>, ) -> Result<(), InvalidUri>

Install the [ProxyConnector<C>] for this ProxyConfig

Errors

Function will error if passed ProxyConnector has a faulty URI.

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for ProxyConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for ProxyConfig

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

Formats the value using the given formatter.

impl Default for ProxyConfig

fn default() -> ProxyConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProxyConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProxyConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProxyConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ProxyConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for ProxyConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl Eq for ProxyConfig

impl StructuralPartialEq for ProxyConfig