Struct HttpOptions 

pub struct HttpOptions { /* private fields */ }

HTTP settings for an update source or for the engine’s downloads: extra request headers and the proxy.

By default no header is added and the proxy comes from the environment (ALL_PROXY, HTTPS_PROXY, HTTP_PROXY, and their lowercase forms), as before. Pass the options to the source (for example StaticManifestSource::http) for metadata requests, and to EngineConfig::http for artifacts, deltas, and their checksum and signature files.

use gpui_updater_core::HttpOptions;

let http = HttpOptions::new()
    .header("authorization", "Bearer s3cr3t")
    .proxy("http://proxy.internal:3128");

Implementations

impl HttpOptions

pub const fn new() -> HttpOptions

No extra headers, and the proxy from the environment.

pub fn header( self, name: impl Into<String>, value: impl Into<String>, ) -> HttpOptions

Send name: value with every request.

Put a credential in authorization: it is dropped when a request is redirected, so a release asset’s storage host never sees it. Every other header goes to redirect targets as well. A header the source sets itself, such as the authorization from GitHubSource::token, takes precedence over one set here. An invalid name or value fails the request.

pub fn proxy(self, url: impl Into<String>) -> HttpOptions

Send requests through the proxy at url instead of the one from the environment. The scheme is http, https, socks4, socks4a, or socks5; credentials go in the URL (http://user:pass@host:port). HTTPS requests are tunnelled, so TLS still ends at the update server. An invalid URL fails every request.

pub fn no_proxy(self) -> HttpOptions

Connect directly, ignoring the proxy environment variables.

Trait Implementations

impl Clone for HttpOptions

fn clone(&self) -> HttpOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpOptions

Shows header names and whether a proxy is set, never header values or the proxy URL, which may hold credentials.

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

Formats the value using the given formatter.

impl Default for HttpOptions

fn default() -> HttpOptions

Returns the “default value” for a type.