Struct Plan 

pub struct Plan {
    pub domain: String,
    pub port: u16,
    pub user: String,
    pub state: PathBuf,
    pub tls_dir: PathBuf,
    pub cert: PathBuf,
    pub key: PathBuf,
    pub marker: PathBuf,
    pub public_url: PathBuf,
    pub hook: PathBuf,
}

Everything the certificate step will touch, built before anything is done so a refusal can name all of it.

Fields

domain: String

The name the certificate is for.

port: u16

The port the node serves on. Part of the public URL, not of the certificate.

user: String

The unprivileged account the node runs as.

state: PathBuf

That account’s ~/.choir.

tls_dir: PathBuf

Where the readable copy of the pair is projected.

cert: PathBuf

The projected certificate.

key: PathBuf

The projected private key.

marker: PathBuf

The two-line file choir node serve reads.

public_url: PathBuf

The one-line file holding the URL people outside use.

hook: PathBuf

The deploy hook certbot runs after every renewal.

Implementations

impl Plan

pub fn new(domain: &str, port: u16, user: &str, home: &Path) -> Plan

The layout for one domain under one node account’s home.

pub fn url(&self) -> String

The URL this node will be reachable at once the pair is in place.

pub fn marker_body(&self) -> String

The two lines the marker holds.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Plan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.

impl PartialEq for Plan

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Plan

impl StructuralPartialEq for Plan