Struct Port 

pub struct Port {
    pub port: u16,
    pub name: Option<String>,
    pub http: bool,
    pub tls: bool,
    pub publish: Option<u16>,
    pub fixed: bool,
    pub dormant: bool,
    pub protocol: Protocol,
}

A port a machine answers on.

Fields

port: u16

The port the machine listens on (what the other machines and the checks connect to).

name: Option<String>

A name for the port (web, api): how outputs and messages refer to it. Default: its port.

http: bool

It speaks HTTP: derived checks request a page instead of only connecting.

tls: bool

It speaks TLS (HTTPS for an http port): probes and checks use TLS, certificates unchecked (lab services sign their own).

publish: Option<u16>

Reachable from the user’s machine on this port (loopback only), besides the environment’s own networks.

fixed: bool

Keep publish as the host port on local Docker too (normally a free one is picked, so labs never collide): for apps whose pages call localhost:<that port> themselves. The environment can’t start while another holds that port.

dormant: bool

Only answers later, once something wakes it (the bind shell an exploit opens): declared, published and opened by reach like any port, but nothing waits for it (healthcheck, readiness probe, depends_on, up --wait) and no derived check expects it to answer.

protocol: Protocol

tcp (default) or udp (DNS, SNMP, TFTP, syslog): published, forwarded and opened as UDP. UDP has no handshake, so nothing waits for it (healthcheck, readiness probe, depends_on) and no derived check probes it: a check of your own says how (exec: dig). A port served over both is two entries, one per protocol.

Trait Implementations

impl Clone for Port

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Port

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Port

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Port

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Port

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Port

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Port