Enum Ingress 

pub enum Ingress {
    Socket(SocketAddr),
    Dns {
        host: Hostname,
        port: u16,
    },
}

What we dial to connect to a peer.

Variants

Socket(SocketAddr)

IP-based ingress address.

Dns

DNS-based ingress address.

Fields

host: Hostname

Hostname to resolve.

port: u16

Port to connect to.

Implementations

impl Ingress

pub const fn port(&self) -> u16

Returns the port number for this ingress address.

pub const fn ip(&self) -> Option<IpAddr>

Returns the IP address if this is a Socket variant.

pub fn is_valid(&self, allow_private_ips: bool, allow_dns: bool) -> bool

Returns whether this ingress address is allowed given the configuration.

• Socket addresses must have a global IP (or allow_private_ips must be true).
• Dns addresses are allowed only if allow_dns is true.

Note: For Dns addresses, private IP checks are performed after resolution in resolve_filtered.

pub async fn resolve( &self, resolver: &impl Resolver, ) -> Result<impl Iterator<Item = SocketAddr>, RuntimeError>

Resolve this ingress address to socket addresses.

For Socket variants, returns a single-element iterator. For Dns variants, performs DNS resolution and returns all resolved addresses.

pub async fn resolve_filtered( &self, resolver: &impl Resolver, allow_private_ips: bool, ) -> Option<impl Iterator<Item = SocketAddr>>

resolve and filter by private IP policy.

Trait Implementations

impl Clone for Ingress

fn clone(&self) -> Ingress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ingress

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

Formats the value using the given formatter.

impl EncodeSize for Ingress

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl Eq for Ingress

impl From<SocketAddr> for Ingress

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl Ord for Ingress

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Ingress

fn partial_cmp(&self, other: &Ingress) -> 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 Read for Ingress

type Cfg = ()

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, _cfg: &Self::Cfg) -> Result<Self, CodecError>

Reads a value from the buffer using the provided configuration cfg.

impl StructuralPartialEq for Ingress

impl Write for Ingress

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.