Enum ProbeTarget 

pub enum ProbeTarget {
    Http {
        host: String,
        port: u16,
        path: String,
    },
    Tcp {
        host: String,
        port: u16,
    },
    Exec {
        command: String,
    },
}

A probe’s target after validation: the form the prober consumes.

Parsing here rather than in the daemon means a malformed target fails the Flockfile, not the first poll ten seconds after the sheep is online.

Variants

Http

http://host[:port]/path: port defaults to 80, path to /.

Fields

host: String

The host or IP literal. A bracketed IPv6 literal ([::1]) has its brackets stripped.

Carried for the prober: connect with (host.as_str(), port), not by formatting "{host}:{port}" into a SocketAddr parse: a stripped IPv6 literal has no brackets to make that string parseable. For the RFC 7230 Host: header, re-bracket an IPv6 host (format!("[{host}]")) before writing it.

port: u16

The port; defaults to 80 when the authority carries none.

path: String

The path; defaults to / when the URL carries none.

Free of whitespace and control characters whenever it came from ProbeTarget::parse: see ProbeTargetError::InvalidPath. The prober writes this verbatim into a request line, so that is a security property, not a tidiness one; a caller that builds this variant by hand rather than parsing takes it on itself.

Tcp

host:port.

Fields

host: String

The host or IP literal. A bracketed IPv6 literal ([::1]) has its brackets stripped.

Carried for the prober: connect with (host.as_str(), port), not by formatting "{host}:{port}" into a SocketAddr parse: a stripped IPv6 literal has no brackets to make that string parseable.

port: u16

The port.

Exec

A command line, run through the platform shell.

Fields

command: String

The command line exactly as written in the Flockfile.

Implementations

impl ProbeTarget

pub fn parse(config: &ProbeConfig) -> Result<Self, ProbeTargetError>

Parses config.target according to config.kind.

Errors

• ProbeTargetError::Empty: the target is empty or all whitespace.
• ProbeTargetError::HttpsUnsupported: an https:// URL.
• ProbeTargetError::NotHttpUrl: no http:// scheme.
• ProbeTargetError::MissingHost: the authority has no host.
• ProbeTargetError::InvalidHost: the host contains @, whitespace, or an embedded :.
• ProbeTargetError::InvalidPath: the path contains whitespace or a control character.
• ProbeTargetError::MissingPort: a TCP target with no :port.
• ProbeTargetError::BadPort: the port is not a u16.

Trait Implementations

impl Clone for ProbeTarget

fn clone(&self) -> ProbeTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProbeTarget

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

Formats the value using the given formatter.

impl Eq for ProbeTarget

impl PartialEq for ProbeTarget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProbeTarget