//! The following is derived from Rust's //! library/std/src/net/socket_addr.rs at revision //! f7e8ba28a4785e698a55fb95e4b3e803302de0ff. //! //! All code in this file is licensed MIT or Apache 2.0 at your option. //! //! This defines `SocketAddr`, `SocketAddrV4`, and `SocketAddrV6` in a //! platform-independent way. It is not the native representation. #![allow(unsafe_code)] use crate::net::ip::{IpAddr, Ipv4Addr, Ipv6Addr}; use core::cmp::Ordering; use core::hash; /// An internet socket address, either IPv4 or IPv6. /// /// Internet socket addresses consist of an [IP address], a 16-bit port number, as well /// as possibly some version-dependent additional information. See [`SocketAddrV4`]'s and /// [`SocketAddrV6`]'s respective documentation for more details. /// /// The size of a `SocketAddr` instance may vary depending on the target operating /// system. /// /// [IP address]: IpAddr /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// /// assert_eq!("127.0.0.1:8080".parse(), Ok(socket)); /// assert_eq!(socket.port(), 8080); /// assert_eq!(socket.is_ipv4(), true); /// ``` #[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] pub enum SocketAddr { /// An IPv4 socket address. #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] V4(#[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] SocketAddrV4), /// An IPv6 socket address. #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] V6(#[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] SocketAddrV6), } /// An IPv4 socket address. /// /// IPv4 socket addresses consist of an [`IPv4` address] and a 16-bit port number, as /// stated in [IETF RFC 793]. /// /// See [`SocketAddr`] for a type encompassing both IPv4 and IPv6 socket addresses. /// /// The size of a `SocketAddrV4` struct may vary depending on the target operating /// system. Do not assume that this type has the same memory layout as the underlying /// system representation. /// /// [IETF RFC 793]: https://tools.ietf.org/html/rfc793 /// [`IPv4` address]: Ipv4Addr /// /// # Examples /// /// ``` /// use std::net::{Ipv4Addr, SocketAddrV4}; /// /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080); /// /// assert_eq!("127.0.0.1:8080".parse(), Ok(socket)); /// assert_eq!(socket.ip(), &Ipv4Addr::new(127, 0, 0, 1)); /// assert_eq!(socket.port(), 8080); /// ``` #[derive(Copy, Clone, Eq, PartialEq)] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] pub struct SocketAddrV4 { ip: Ipv4Addr, port: u16, } /// An IPv6 socket address. /// /// IPv6 socket addresses consist of an [`IPv6` address], a 16-bit port number, as well /// as fields containing the traffic class, the flow label, and a scope identifier /// (see [IETF RFC 2553, Section 3.3] for more details). /// /// See [`SocketAddr`] for a type encompassing both IPv4 and IPv6 socket addresses. /// /// The size of a `SocketAddrV6` struct may vary depending on the target operating /// system. Do not assume that this type has the same memory layout as the underlying /// system representation. /// /// [IETF RFC 2553, Section 3.3]: https://tools.ietf.org/html/rfc2553#section-3.3 /// [`IPv6` address]: Ipv6Addr /// /// # Examples /// /// ``` /// use std::net::{Ipv6Addr, SocketAddrV6}; /// /// let socket = SocketAddrV6::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1), 8080, 0, 0); /// /// assert_eq!("[2001:db8::1]:8080".parse(), Ok(socket)); /// assert_eq!(socket.ip(), &Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1)); /// assert_eq!(socket.port(), 8080); /// ``` #[derive(Copy, Clone, Eq, PartialEq)] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] pub struct SocketAddrV6 { ip: Ipv6Addr, port: u16, flowinfo: u32, scope_id: u32, } impl SocketAddr { /// Creates a new socket address from an [IP address] and a port number. /// /// [IP address]: IpAddr /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1))); /// assert_eq!(socket.port(), 8080); /// ``` #[cfg_attr(staged_api, stable(feature = "ip_addr", since = "1.7.0"))] #[must_use] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn new(ip: IpAddr, port: u16) -> SocketAddr { match ip { IpAddr::V4(a) => SocketAddr::V4(SocketAddrV4::new(a, port)), IpAddr::V6(a) => SocketAddr::V6(SocketAddrV6::new(a, port, 0, 0)), } } /// Returns the IP address associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1))); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "ip_addr", since = "1.7.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn ip(&self) -> IpAddr { match *self { SocketAddr::V4(ref a) => IpAddr::V4(*a.ip()), SocketAddr::V6(ref a) => IpAddr::V6(*a.ip()), } } /// Changes the IP address associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let mut socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// socket.set_ip(IpAddr::V4(Ipv4Addr::new(10, 10, 0, 1))); /// assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(10, 10, 0, 1))); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_ip(&mut self, new_ip: IpAddr) { // `match (*self, new_ip)` would have us mutate a copy of self only to throw it away. match (self, new_ip) { (&mut SocketAddr::V4(ref mut a), IpAddr::V4(new_ip)) => a.set_ip(new_ip), (&mut SocketAddr::V6(ref mut a), IpAddr::V6(new_ip)) => a.set_ip(new_ip), (self_, new_ip) => *self_ = Self::new(new_ip, self_.port()), } } /// Returns the port number associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// assert_eq!(socket.port(), 8080); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn port(&self) -> u16 { match *self { SocketAddr::V4(ref a) => a.port(), SocketAddr::V6(ref a) => a.port(), } } /// Changes the port number associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let mut socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// socket.set_port(1025); /// assert_eq!(socket.port(), 1025); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_port(&mut self, new_port: u16) { match *self { SocketAddr::V4(ref mut a) => a.set_port(new_port), SocketAddr::V6(ref mut a) => a.set_port(new_port), } } /// Returns [`true`] if the [IP address] in this `SocketAddr` is an /// [`IPv4` address], and [`false`] otherwise. /// /// [IP address]: IpAddr /// [`IPv4` address]: IpAddr::V4 /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr}; /// /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080); /// assert_eq!(socket.is_ipv4(), true); /// assert_eq!(socket.is_ipv6(), false); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "sockaddr_checker", since = "1.16.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn is_ipv4(&self) -> bool { matches!(*self, SocketAddr::V4(_)) } /// Returns [`true`] if the [IP address] in this `SocketAddr` is an /// [`IPv6` address], and [`false`] otherwise. /// /// [IP address]: IpAddr /// [`IPv6` address]: IpAddr::V6 /// /// # Examples /// /// ``` /// use std::net::{IpAddr, Ipv6Addr, SocketAddr}; /// /// let socket = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 0, 1)), 8080); /// assert_eq!(socket.is_ipv4(), false); /// assert_eq!(socket.is_ipv6(), true); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "sockaddr_checker", since = "1.16.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn is_ipv6(&self) -> bool { matches!(*self, SocketAddr::V6(_)) } } impl SocketAddrV4 { /// Creates a new socket address from an [`IPv4` address] and a port number. /// /// [`IPv4` address]: Ipv4Addr /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV4, Ipv4Addr}; /// /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080); /// ``` #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[must_use] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn new(ip: Ipv4Addr, port: u16) -> SocketAddrV4 { SocketAddrV4 { ip, port } } /// Returns the IP address associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV4, Ipv4Addr}; /// /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080); /// assert_eq!(socket.ip(), &Ipv4Addr::new(127, 0, 0, 1)); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn ip(&self) -> &Ipv4Addr { &self.ip } /// Changes the IP address associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV4, Ipv4Addr}; /// /// let mut socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080); /// socket.set_ip(Ipv4Addr::new(192, 168, 0, 1)); /// assert_eq!(socket.ip(), &Ipv4Addr::new(192, 168, 0, 1)); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_ip(&mut self, new_ip: Ipv4Addr) { self.ip = new_ip; } /// Returns the port number associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV4, Ipv4Addr}; /// /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080); /// assert_eq!(socket.port(), 8080); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn port(&self) -> u16 { self.port } /// Changes the port number associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV4, Ipv4Addr}; /// /// let mut socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080); /// socket.set_port(4242); /// assert_eq!(socket.port(), 4242); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_port(&mut self, new_port: u16) { self.port = new_port; } } impl SocketAddrV6 { /// Creates a new socket address from an [`IPv6` address], a 16-bit port number, /// and the `flowinfo` and `scope_id` fields. /// /// For more information on the meaning and layout of the `flowinfo` and `scope_id` /// parameters, see [IETF RFC 2553, Section 3.3]. /// /// [IETF RFC 2553, Section 3.3]: https://tools.ietf.org/html/rfc2553#section-3.3 /// [`IPv6` address]: Ipv6Addr /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0); /// ``` #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[must_use] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn new(ip: Ipv6Addr, port: u16, flowinfo: u32, scope_id: u32) -> SocketAddrV6 { SocketAddrV6 { ip, port, flowinfo, scope_id, } } /// Returns the IP address associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0); /// assert_eq!(socket.ip(), &Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn ip(&self) -> &Ipv6Addr { &self.ip } /// Changes the IP address associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0); /// socket.set_ip(Ipv6Addr::new(76, 45, 0, 0, 0, 0, 0, 0)); /// assert_eq!(socket.ip(), &Ipv6Addr::new(76, 45, 0, 0, 0, 0, 0, 0)); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_ip(&mut self, new_ip: Ipv6Addr) { self.ip = new_ip; } /// Returns the port number associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0); /// assert_eq!(socket.port(), 8080); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn port(&self) -> u16 { self.port } /// Changes the port number associated with this socket address. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0); /// socket.set_port(4242); /// assert_eq!(socket.port(), 4242); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_port(&mut self, new_port: u16) { self.port = new_port; } /// Returns the flow information associated with this address. /// /// This information corresponds to the `sin6_flowinfo` field in C's `netinet/in.h`, /// as specified in [IETF RFC 2553, Section 3.3]. /// It combines information about the flow label and the traffic class as specified /// in [IETF RFC 2460], respectively [Section 6] and [Section 7]. /// /// [IETF RFC 2553, Section 3.3]: https://tools.ietf.org/html/rfc2553#section-3.3 /// [IETF RFC 2460]: https://tools.ietf.org/html/rfc2460 /// [Section 6]: https://tools.ietf.org/html/rfc2460#section-6 /// [Section 7]: https://tools.ietf.org/html/rfc2460#section-7 /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0); /// assert_eq!(socket.flowinfo(), 10); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn flowinfo(&self) -> u32 { self.flowinfo } /// Changes the flow information associated with this socket address. /// /// See [`SocketAddrV6::flowinfo`]'s documentation for more details. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0); /// socket.set_flowinfo(56); /// assert_eq!(socket.flowinfo(), 56); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_flowinfo(&mut self, new_flowinfo: u32) { self.flowinfo = new_flowinfo; } /// Returns the scope ID associated with this address. /// /// This information corresponds to the `sin6_scope_id` field in C's `netinet/in.h`, /// as specified in [IETF RFC 2553, Section 3.3]. /// /// [IETF RFC 2553, Section 3.3]: https://tools.ietf.org/html/rfc2553#section-3.3 /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 78); /// assert_eq!(socket.scope_id(), 78); /// ``` #[must_use] #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] #[cfg_attr( staged_api, rustc_const_unstable(feature = "const_socketaddr", issue = "82485") )] pub const fn scope_id(&self) -> u32 { self.scope_id } /// Changes the scope ID associated with this socket address. /// /// See [`SocketAddrV6::scope_id`]'s documentation for more details. /// /// # Examples /// /// ``` /// use std::net::{SocketAddrV6, Ipv6Addr}; /// /// let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 78); /// socket.set_scope_id(42); /// assert_eq!(socket.scope_id(), 42); /// ``` #[cfg_attr(staged_api, stable(feature = "sockaddr_setters", since = "1.9.0"))] pub fn set_scope_id(&mut self, new_scope_id: u32) { self.scope_id = new_scope_id; } } #[cfg_attr(staged_api, stable(feature = "ip_from_ip", since = "1.16.0"))] impl From for SocketAddr { /// Converts a [`SocketAddrV4`] into a [`SocketAddr::V4`]. fn from(sock4: SocketAddrV4) -> SocketAddr { SocketAddr::V4(sock4) } } #[cfg_attr(staged_api, stable(feature = "ip_from_ip", since = "1.16.0"))] impl From for SocketAddr { /// Converts a [`SocketAddrV6`] into a [`SocketAddr::V6`]. fn from(sock6: SocketAddrV6) -> SocketAddr { SocketAddr::V6(sock6) } } #[cfg_attr(staged_api, stable(feature = "addr_from_into_ip", since = "1.17.0"))] impl> From<(I, u16)> for SocketAddr { /// Converts a tuple struct (Into<[`IpAddr`]>, `u16`) into a [`SocketAddr`]. /// /// This conversion creates a [`SocketAddr::V4`] for an [`IpAddr::V4`] /// and creates a [`SocketAddr::V6`] for an [`IpAddr::V6`]. /// /// `u16` is treated as port of the newly created [`SocketAddr`]. fn from(pieces: (I, u16)) -> SocketAddr { SocketAddr::new(pieces.0.into(), pieces.1) } } #[cfg_attr(staged_api, stable(feature = "socketaddr_ordering", since = "1.45.0"))] impl PartialOrd for SocketAddrV4 { fn partial_cmp(&self, other: &SocketAddrV4) -> Option { Some(self.cmp(other)) } } #[cfg_attr(staged_api, stable(feature = "socketaddr_ordering", since = "1.45.0"))] impl PartialOrd for SocketAddrV6 { fn partial_cmp(&self, other: &SocketAddrV6) -> Option { Some(self.cmp(other)) } } #[cfg_attr(staged_api, stable(feature = "socketaddr_ordering", since = "1.45.0"))] impl Ord for SocketAddrV4 { fn cmp(&self, other: &SocketAddrV4) -> Ordering { self.ip() .cmp(other.ip()) .then(self.port().cmp(&other.port())) } } #[cfg_attr(staged_api, stable(feature = "socketaddr_ordering", since = "1.45.0"))] impl Ord for SocketAddrV6 { fn cmp(&self, other: &SocketAddrV6) -> Ordering { self.ip() .cmp(other.ip()) .then(self.port().cmp(&other.port())) } } #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] impl hash::Hash for SocketAddrV4 { fn hash(&self, s: &mut H) { (self.port, self.ip).hash(s) } } #[cfg_attr(staged_api, stable(feature = "rust1", since = "1.0.0"))] impl hash::Hash for SocketAddrV6 { fn hash(&self, s: &mut H) { (self.port, &self.ip, self.flowinfo, self.scope_id).hash(s) } }