Struct Publish 

pub struct Publish { /* private fields */ }

Port publishing configuration for container networking.

Specifies how container ports are exposed to the host system. The format follows Docker’s --publish flag: [[ip:][hostPort]:]containerPort[/protocol]

Implementations

impl Publish

pub fn tcp(container_port: u16) -> Self

Creates a TCP port publish configuration.

Example

let publish = ociman::Publish::tcp(8080);
assert_eq!(publish.to_string(), "8080/tcp");

pub fn udp(container_port: u16) -> Self

Creates a UDP port publish configuration.

Example

let publish = ociman::Publish::udp(53);
assert_eq!(publish.to_string(), "53/udp");

pub fn host_ip(self, ip: IpAddr) -> Self

Sets the host IP address to bind to.

Examples

let publish = ociman::Publish::tcp(8080)
    .host_ip(std::net::Ipv4Addr::LOCALHOST.into());
assert_eq!(publish.to_string(), "127.0.0.1::8080/tcp");

With unspecified address:

let publish = ociman::Publish::tcp(5432)
    .host_ip(std::net::Ipv4Addr::UNSPECIFIED.into());
assert_eq!(publish.to_string(), "0.0.0.0::5432/tcp");

With IPv6:

let publish = ociman::Publish::tcp(8080)
    .host_ip(std::net::Ipv6Addr::LOCALHOST.into());
assert_eq!(publish.to_string(), "::1::8080/tcp");

Preserves previously set host port:

let publish = ociman::Publish::tcp(80)
    .host_port(8080)
    .host_ip(std::net::Ipv4Addr::LOCALHOST.into());
assert_eq!(publish.to_string(), "127.0.0.1:8080:80/tcp");

pub fn host_port(self, port: u16) -> Self

Sets the host port to map to the container port.

If no host IP has been set, defaults to 0.0.0.0.

Examples

let publish = ociman::Publish::tcp(80).host_port(8080);
assert_eq!(publish.to_string(), "0.0.0.0:8080:80/tcp");

Preserves previously set host IP:

let publish = ociman::Publish::tcp(80)
    .host_ip(std::net::Ipv4Addr::LOCALHOST.into())
    .host_port(8080);
assert_eq!(publish.to_string(), "127.0.0.1:8080:80/tcp");

pub fn host_ip_port(self, ip: IpAddr, port: u16) -> Self

Sets both host IP and port in a single call.

Example

let publish = ociman::Publish::tcp(80)
    .host_ip_port(std::net::Ipv4Addr::LOCALHOST.into(), 8080);
assert_eq!(publish.to_string(), "127.0.0.1:8080:80/tcp");

Trait Implementations

impl Clone for Publish

fn clone(&self) -> Publish

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Publish

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

Formats the value using the given formatter.

impl Display for Publish

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

Formats the value using the given formatter.

impl PartialEq for Publish

fn eq(&self, other: &Publish) -> 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 Publish

impl StructuralPartialEq for Publish