Struct SetupContext 

pub struct SetupContext {

    pub platform: Platform,
    pub tld: String,
    pub dns_port: u16,
    pub proxy_port: u16,
    pub https: bool,
    pub dns_enabled: bool,
    pub pac: bool,
    pub systemd_resolved: bool,
    pub systemd_version: Option<u32>,
    pub lan: bool,
    pub contact_host: String,
    pub ca_path: PathBuf,
    pub ca_trusted: bool,
    pub custom_cert: bool,
    pub generated_ca: PathBuf,
    pub binary: PathBuf,
    pub resolver_dir: PathBuf,
    pub resolved_dropin_dir: PathBuf,
    pub pf_conf: PathBuf,
    pub pf_anchor: PathBuf,
    pub network_services: Vec<String>,
    pub gnome: bool,
    pub prior_auto_proxy: Vec<PriorAutoProxy>,
}

Everything the plan depends on, gathered up front so planning is pure.

Serialized after a run so --undo can reverse what setup actually did rather than what the settings say now. Between the two, proxy.tld, proxy.port, proxy.host or proxy.tls_cert may well have changed, and undo built from the new values would probe for a different iptables rule or PAC URL and leave the real ones in place.

Fields

platform: Platform

tld: String

TLD proxy URLs live under.

dns_port: u16

Port the loopback resolver listens on.

proxy_port: u16

Port the proxy listens on.

https: bool

Whether the proxy serves HTTPS (decides CA steps and which standard port matters).

dns_enabled: bool

Whether the loopback resolver is enabled at all.

pac: bool

Configure the system through a PAC file instead of the resolver.

systemd_resolved: bool

Whether systemd-resolved is the active stub resolver.

systemd_version: Option<u32>

Major version of systemd, when it could be determined.

lan: bool

Whether LAN mode is on, in which case .local is mDNS territory.

contact_host: String

Address a local client uses to reach the proxy, as it appears in a URL.

Normally 127.0.0.1, but proxy.host = "::1" means nothing is listening on IPv4 and the PAC file has to say so.

ca_path: PathBuf

Path to the CA certificate.

ca_trusted: bool

Whether the CA is already in the system trust store.

custom_cert: bool

Whether a custom tls_cert is configured (pitchfork then owns no CA).

generated_ca: PathBuf

Where the CA pitchfork generates lives, whatever proxy.tls_cert says.

Undo works from this rather than ca_path: configuring a custom certificate later must not hide a CA an earlier setup installed.

Records written before this field existed default to the current generated path rather than to an empty one, which would have planned the removal of nothing.

binary: PathBuf

Path to the running pitchfork binary, used for setcap and re-invocation.

resolver_dir: PathBuf

Directory holding per-domain macOS resolver files (/etc/resolver).

resolved_dropin_dir: PathBuf

Directory holding systemd-resolved drop-ins.

pf_conf: PathBuf

Path to pf.conf on macOS.

pf_anchor: PathBuf

Path to the pitchfork pf anchor file on macOS.

network_services: Vec<String>

Active macOS network services to point at the PAC file.

gnome: bool

Whether the GNOME proxy settings are available.

prior_auto_proxy: Vec<PriorAutoProxy>

The automatic-proxy configuration found before --pac overwrote it.

Without this, --undo can only switch the proxy off: it has nothing to put back, so a machine that already had a corporate or hand-written PAC URL would lose it the first time setup --pac ran. Entries pointing at pitchfork’s own PAC file are not recorded, so re-running setup cannot overwrite a genuine earlier value with our own.

Records written before this field existed simply have none, which leaves undo behaving as it did before.

Trait Implementations

impl Clone for SetupContext

fn clone(&self) -> SetupContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetupContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SetupContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SetupContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.