Struct SocketAddress

pub struct SocketAddress {
    pub protocol: i32,
    pub address: String,
    pub resolver_name: String,
    pub ipv4_compat: bool,
    pub port_specifier: Option<PortSpecifier>,
}

[#next-free-field: 7]

Fields

protocol: i32

address: String

The address for this socket. :ref:Listeners <config_listeners> will bind to the address. An empty address is not allowed. Specify 0.0.0.0 or :: to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>.] When used within an upstream :ref:BindConfig <envoy_v3_api_msg_config.core.v3.BindConfig>, the address controls the source address of outbound connections. For :ref:clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>, the cluster type determines whether the address must be an IP (STATIC or EDS clusters) or a hostname resolved by DNS (STRICT_DNS or LOGICAL_DNS clusters). Address resolution can be customized via :ref:resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>.

resolver_name: String

The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with STRICT_DNS or LOGICAL_DNS will generate an error at runtime.

ipv4_compat: bool

When binding to an IPv6 address above, this enables IPv4 compatibility <<https://tools.ietf.org/html/rfc3493#page-11>_.> Binding to :: will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ::FFFF:<IPv4-address>.

port_specifier: Option<PortSpecifier>

Implementations

impl SocketAddress

pub fn protocol(&self) -> Protocol

Returns the enum value of protocol, or the default if the field is set to an invalid enum value.

pub fn set_protocol(&mut self, value: Protocol)

Sets protocol to the provided enum value.

Trait Implementations

impl Clone for SocketAddress

fn clone(&self) -> SocketAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketAddress

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

Formats the value using the given formatter.

impl Default for SocketAddress

fn default() -> Self

Returns the “default value” for a type.

impl Message for SocketAddress

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for SocketAddress

const NAME: &'static str = "SocketAddress"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.core.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for SocketAddress

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