Struct Port 

pub struct Port(/* private fields */);

NewType wrapper for ports to provide type safety Uses NonZeroU16 internally to guarantee valid port numbers (1-65535)

Implementations

impl Port

pub const fn new(port: u16) -> Option<Self>

Create a new port, validating it’s not zero

pub const fn system_port(port: u16) -> Option<Self>

Create a port from a system port number (0-1023)

System Ports (per RFC 6335) are reserved for system services and require elevated privileges.

pub const fn user_port(port: u16) -> Option<Self>

Create a port from a user port number range (1024-49151)

User Ports (per RFC 6335) are assigned by IANA for user applications.

pub const fn dynamic_port(port: u16) -> Option<Self>

Create a port from a dynamic port number range (49152-65535)

Dynamic Ports (per RFC 6335) are used for temporary or private connections.

pub const fn new_unchecked(port: u16) -> Self

Create a new port without validation (for known valid values) Only use this when you know the port is valid (not zero)

This method is safe because it panics at compile-time if called with an invalid port number (like 0), preventing runtime errors. It’s optimized for known valid port constants.

pub const fn http() -> Self

Common HTTP port (80)

pub const fn https() -> Self

Common HTTPS port (443)

pub const fn ssh() -> Self

Common SSH port (22)

pub const fn postgres() -> Self

Common PostgreSQL port (5432)

pub const fn mysql() -> Self

Common MySQL port (3306)

pub const fn redis() -> Self

Common Redis port (6379)

pub const fn get(&self) -> u16

Get the inner port value

pub const fn is_system_port(&self) -> bool

Check if this port is a System Port (0-1023)

System Ports (per RFC 6335) are reserved for system services and require elevated privileges.

Examples

use waitup::Port;

let http = Port::http();
assert!(http.is_system_port());

let app_port = Port::new(8080).unwrap();
assert!(!app_port.is_system_port());

pub const fn is_user_port(&self) -> bool

Check if this port is a User Port (1024-49151)

User Ports (per RFC 6335) are assigned by IANA for user applications.

Examples

use waitup::Port;

let app_port = Port::new(8080).unwrap();
assert!(app_port.is_user_port());

let http = Port::http();
assert!(!http.is_user_port());

pub const fn is_dynamic_port(&self) -> bool

Check if this port is a Dynamic Port (49152-65535)

Dynamic Ports (per RFC 6335) are used for temporary or private connections.

Examples

use waitup::Port;

let ephemeral = Port::new(50000).unwrap();
assert!(ephemeral.is_dynamic_port());

let http = Port::http();
assert!(!http.is_dynamic_port());

pub const fn category(&self) -> PortCategory

Get the RFC 6335 category for this port

Returns the port category (System, User, or Dynamic) as defined by RFC 6335. This method enables exhaustive pattern matching on port categories.

Examples

use waitup::{Port, PortCategory};

let http = Port::http();
assert_eq!(http.category(), PortCategory::System);

let app_port = Port::new(8080).unwrap();
assert_eq!(app_port.category(), PortCategory::User);

let ephemeral = Port::new(50000).unwrap();
assert_eq!(ephemeral.category(), PortCategory::Dynamic);

// Pattern matching example
match http.category() {
    PortCategory::System => println!("Requires elevated privileges"),
    PortCategory::User => println!("Standard application port"),
    PortCategory::Dynamic => println!("Temporary/ephemeral port"),
    _ => {} // Required due to #[non_exhaustive]
}

Trait Implementations

impl Clone for Port

fn clone(&self) -> Port

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 Display for Port

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

Formats the value using the given formatter.

impl From<Port> for NonZeroU16

fn from(port: Port) -> Self

Converts to this type from the input type.

impl From<Port> for u16

fn from(port: Port) -> Self

Converts to this type from the input type.

impl FromStr for Port

Parse port from string representations

type Err = WaitForError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for Port

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Port

fn cmp(&self, other: &Port) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Port

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

fn partial_cmp(&self, other: &Port) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<NonZero<u16>> for Port

type Error = WaitForError

The type returned in the event of a conversion error.

fn try_from(port: NonZeroU16) -> Result<Self>

Performs the conversion.

impl TryFrom<i32> for Port

type Error = WaitForError

The type returned in the event of a conversion error.

fn try_from(port: i32) -> Result<Self>

Performs the conversion.

impl TryFrom<u16> for Port

type Error = WaitForError

The type returned in the event of a conversion error.

fn try_from(port: u16) -> Result<Self>

Performs the conversion.

impl TryFrom<u32> for Port

type Error = WaitForError

The type returned in the event of a conversion error.

fn try_from(port: u32) -> Result<Self>

Performs the conversion.

impl TryFrom<usize> for Port

type Error = WaitForError

The type returned in the event of a conversion error.

fn try_from(port: usize) -> Result<Self>

Performs the conversion.

impl Copy for Port

impl Eq for Port

impl StructuralPartialEq for Port