[Protocol] Replace IpAddr with SocketAddr in protocols (#44)

* [Crate] Replace IpAddr with SocketAddr in protocols

* [Crate] Remove usage of address.to_string in socket

* [Crate] Update CHANGELOG.md

src/protocols/gamespy/protocols/one/protocol.rs

@@ -8,17 +8,15 @@ use crate::{
     GDError,
     GDResult,
 };
-
 use crate::protocols::gamespy::common::has_password;
 use std::collections::HashMap;
-use std::net::IpAddr;
+use std::net::SocketAddr;
 
 fn get_server_values(
-    address: &IpAddr,
-    port: u16,
+    address: &SocketAddr,
     timeout_settings: Option<TimeoutSettings>,
 ) -> GDResult<HashMap<String, String>> {
-    let mut socket = UdpSocket::new(address, port)?;
+    let mut socket = UdpSocket::new(address)?;
     socket.apply_timeout(timeout_settings)?;
 
     socket.send("\\status\\xserverquery".as_bytes())?;
@@ -178,18 +176,17 @@ fn extract_players(server_vars: &mut HashMap<String, String>, players_maximum: u
 /// If there are parsing problems using the `query` function, you can directly
 /// get the server's values using this function.
 pub fn query_vars(
-    address: &IpAddr,
-    port: u16,
+    address: &SocketAddr,
     timeout_settings: Option<TimeoutSettings>,
 ) -> GDResult<HashMap<String, String>> {
-    get_server_values(address, port, timeout_settings)
+    get_server_values(address, timeout_settings)
 }
 
 /// Query a server by providing the address, the port and timeout settings.
 /// Providing None to the timeout settings results in using the default values.
 /// (TimeoutSettings::[default](TimeoutSettings::default)).
-pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response> {
-    let mut server_vars = query_vars(address, port, timeout_settings)?;
+pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response> {
+    let mut server_vars = query_vars(address, timeout_settings)?;
 
     let players_maximum = server_vars
         .remove("maxplayers")

src/protocols/gamespy/protocols/three/protocol.rs

@@ -5,7 +5,7 @@ use crate::protocols::types::TimeoutSettings;
 use crate::socket::{Socket, UdpSocket};
 use crate::{GDError, GDResult};
 use std::collections::HashMap;
-use std::net::IpAddr;
+use std::net::SocketAddr;
 
 const THIS_SESSION_ID: u32 = 1;
 
@@ -43,8 +43,8 @@ struct GameSpy3 {
 const PACKET_SIZE: usize = 2048;
 
 impl GameSpy3 {
-    fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = UdpSocket::new(address, port)?;
+    fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = UdpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -104,8 +104,8 @@ impl GameSpy3 {
     }
 }
 
-fn get_server_packets(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Vec<Vec<u8>>> {
-    let mut gs3 = GameSpy3::new(address, port, timeout_settings)?;
+fn get_server_packets(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Vec<Vec<u8>>> {
+    let mut gs3 = GameSpy3::new(address, timeout_settings)?;
 
     let challenge = gs3.make_initial_handshake()?;
     gs3.send_data_request(challenge)?;
@@ -165,11 +165,10 @@ fn data_to_map(packet: &[u8]) -> GDResult<(HashMap<String, String>, Vec<u8>)> {
 /// If there are parsing problems using the `query` function, you can directly
 /// get the server's values using this function.
 pub fn query_vars(
-    address: &IpAddr,
-    port: u16,
+    address: &SocketAddr,
     timeout_settings: Option<TimeoutSettings>,
 ) -> GDResult<HashMap<String, String>> {
-    let packets = get_server_packets(address, port, timeout_settings)?;
+    let packets = get_server_packets(address, timeout_settings)?;
 
     let mut vars = HashMap::new();
 
@@ -308,8 +307,8 @@ fn parse_players_and_teams(packets: Vec<Vec<u8>>) -> GDResult<(Vec<Player>, Vec<
 /// Query a server by providing the address, the port and timeout settings.
 /// Providing None to the timeout settings results in using the default values.
 /// (TimeoutSettings::[default](TimeoutSettings::default)).
-pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response> {
-    let packets = get_server_packets(address, port, timeout_settings)?;
+pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response> {
+    let packets = get_server_packets(address, timeout_settings)?;
 
     let (mut server_vars, remaining_data) = data_to_map(packets.get(0).ok_or(GDError::PacketBad)?)?;
 

src/protocols/minecraft/protocol/bedrock.rs

@@ -1,7 +1,7 @@
 // This file has code that has been documented by the NodeJS GameDig library
 // (MIT) from https://github.com/gamedig/node-gamedig/blob/master/protocols/minecraftbedrock.js
 
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use crate::{
     bufferer::{Bufferer, Endianess},
     protocols::{
@@ -19,8 +19,8 @@ pub struct Bedrock {
 }
 
 impl Bedrock {
-    fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = UdpSocket::new(address, port)?;
+    fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = UdpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -93,7 +93,7 @@ impl Bedrock {
         })
     }
 
-    pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<BedrockResponse> {
-        Bedrock::new(address, port, timeout_settings)?.get_info()
+    pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<BedrockResponse> {
+        Bedrock::new(address, timeout_settings)?.get_info()
     }
 }

src/protocols/minecraft/protocol/java.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use crate::{
     bufferer::{Bufferer, Endianess},
     protocols::{
@@ -31,8 +31,8 @@ pub struct Java {
 }
 
 impl Java {
-    fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = TcpSocket::new(address, port)?;
+    fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = TcpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -139,7 +139,7 @@ impl Java {
         })
     }
 
-    pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-        Java::new(address, port, timeout_settings)?.get_info()
+    pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+        Java::new(address, timeout_settings)?.get_info()
     }
 }

src/protocols/minecraft/protocol/legacy_bv1_8.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use crate::{
     bufferer::{Bufferer, Endianess},
     protocols::{
@@ -16,8 +16,8 @@ pub struct LegacyBV1_8 {
 }
 
 impl LegacyBV1_8 {
-    fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = TcpSocket::new(address, port)?;
+    fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = TcpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -60,7 +60,7 @@ impl LegacyBV1_8 {
         })
     }
 
-    pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-        LegacyBV1_8::new(address, port, timeout_settings)?.get_info()
+    pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+        LegacyBV1_8::new(address, timeout_settings)?.get_info()
     }
 }

src/protocols/minecraft/protocol/legacy_v1_4.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use crate::{
     bufferer::{Bufferer, Endianess},
     protocols::{
@@ -16,8 +16,8 @@ pub struct LegacyV1_4 {
 }
 
 impl LegacyV1_4 {
-    fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = TcpSocket::new(address, port)?;
+    fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = TcpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -64,7 +64,7 @@ impl LegacyV1_4 {
         })
     }
 
-    pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-        LegacyV1_4::new(address, port, timeout_settings)?.get_info()
+    pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+        LegacyV1_4::new(address, timeout_settings)?.get_info()
     }
 }

src/protocols/minecraft/protocol/legacy_v1_6.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use crate::{
     bufferer::{Bufferer, Endianess},
     protocols::{
@@ -16,8 +16,8 @@ pub struct LegacyV1_6 {
 }
 
 impl LegacyV1_6 {
-    fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = TcpSocket::new(address, port)?;
+    fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = TcpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -93,7 +93,7 @@ impl LegacyV1_6 {
         LegacyV1_6::get_response(&mut buffer)
     }
 
-    pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-        LegacyV1_6::new(address, port, timeout_settings)?.get_info()
+    pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+        LegacyV1_6::new(address, timeout_settings)?.get_info()
     }
 }

src/protocols/minecraft/protocol/mod.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use crate::{
     protocols::minecraft::{
         protocol::{
@@ -25,16 +25,16 @@ mod legacy_v1_6;
 
 /// Queries a Minecraft server with all the protocol variants one by one (Java
 /// -> Bedrock -> Legacy (1.6 -> 1.4 -> Beta 1.8)).
-pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-    if let Ok(response) = query_java(address, port, timeout_settings.clone()) {
+pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+    if let Ok(response) = query_java(address, timeout_settings.clone()) {
         return Ok(response);
     }
 
-    if let Ok(response) = query_bedrock(address, port, timeout_settings.clone()) {
+    if let Ok(response) = query_bedrock(address, timeout_settings.clone()) {
         return Ok(JavaResponse::from_bedrock_response(response));
     }
 
-    if let Ok(response) = query_legacy(address, port, timeout_settings) {
+    if let Ok(response) = query_legacy(address, timeout_settings) {
         return Ok(response);
     }
 
@@ -42,21 +42,21 @@ pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettin
 }
 
 /// Query a Java Server.
-pub fn query_java(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-    Java::query(address, port, timeout_settings)
+pub fn query_java(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+    Java::query(address, timeout_settings)
 }
 
 /// Query a (Java) Legacy Server (1.6 -> 1.4 -> Beta 1.8).
-pub fn query_legacy(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
-    if let Ok(response) = query_legacy_specific(LegacyGroup::V1_6, address, port, timeout_settings.clone()) {
+pub fn query_legacy(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<JavaResponse> {
+    if let Ok(response) = query_legacy_specific(LegacyGroup::V1_6, address, timeout_settings.clone()) {
         return Ok(response);
     }
 
-    if let Ok(response) = query_legacy_specific(LegacyGroup::V1_4, address, port, timeout_settings.clone()) {
+    if let Ok(response) = query_legacy_specific(LegacyGroup::V1_4, address, timeout_settings.clone()) {
         return Ok(response);
     }
 
-    if let Ok(response) = query_legacy_specific(LegacyGroup::VB1_8, address, port, timeout_settings) {
+    if let Ok(response) = query_legacy_specific(LegacyGroup::VB1_8, address, timeout_settings) {
         return Ok(response);
     }
 
@@ -66,18 +66,17 @@ pub fn query_legacy(address: &IpAddr, port: u16, timeout_settings: Option<Timeou
 /// Query a specific (Java) Legacy Server.
 pub fn query_legacy_specific(
     group: LegacyGroup,
-    address: &IpAddr,
-    port: u16,
+    address: &SocketAddr,
     timeout_settings: Option<TimeoutSettings>,
 ) -> GDResult<JavaResponse> {
     match group {
-        LegacyGroup::V1_6 => LegacyV1_6::query(address, port, timeout_settings),
-        LegacyGroup::V1_4 => LegacyV1_4::query(address, port, timeout_settings),
-        LegacyGroup::VB1_8 => LegacyBV1_8::query(address, port, timeout_settings),
+        LegacyGroup::V1_6 => LegacyV1_6::query(address, timeout_settings),
+        LegacyGroup::V1_4 => LegacyV1_4::query(address, timeout_settings),
+        LegacyGroup::VB1_8 => LegacyBV1_8::query(address, timeout_settings),
     }
 }
 
 /// Query a Bedrock Server.
-pub fn query_bedrock(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<BedrockResponse> {
-    Bedrock::query(address, port, timeout_settings)
+pub fn query_bedrock(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<BedrockResponse> {
+    Bedrock::query(address, timeout_settings)
 }

src/protocols/quake/client.rs

@@ -1,5 +1,5 @@
 use std::collections::HashMap;
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use std::slice::Iter;
 use crate::bufferer::{Bufferer, Endianess};
 use crate::{GDError, GDResult};
@@ -15,8 +15,8 @@ pub(crate) trait QuakeClient {
     fn parse_player_string(data: Iter<&str>) -> GDResult<Self::Player>;
 }
 
-fn get_data<Client: QuakeClient>(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Bufferer> {
-    let mut socket = UdpSocket::new(address, port)?;
+fn get_data<Client: QuakeClient>(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Bufferer> {
+    let mut socket = UdpSocket::new(address)?;
     socket.apply_timeout(timeout_settings)?;
 
     socket.send(&[&[0xFF, 0xFF, 0xFF, 0xFF], Client::get_send_header().as_bytes(), &[0x00]].concat())?;
@@ -78,8 +78,8 @@ fn get_players<Client: QuakeClient>(bufferer: &mut Bufferer) -> GDResult<Vec<Cli
     Ok(players)
 }
 
-pub(crate) fn client_query<Client: QuakeClient>(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Client::Player>> {
-    let mut bufferer = get_data::<Client>(address, port, timeout_settings)?;
+pub(crate) fn client_query<Client: QuakeClient>(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Client::Player>> {
+    let mut bufferer = get_data::<Client>(address, timeout_settings)?;
 
     let mut server_vars = get_server_values(&mut bufferer)?;
     let players = get_players::<Client>(&mut bufferer)?;

src/protocols/quake/one.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use std::slice::Iter;
 use crate::{GDError, GDResult};
 use crate::protocols::quake::Response;
@@ -72,6 +72,6 @@ impl QuakeClient for QuakeOne {
     }
 }
 
-pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Player>> {
-    client_query::<QuakeOne>(address, port, timeout_settings)
+pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Player>> {
+    client_query::<QuakeOne>(address, timeout_settings)
 }

src/protocols/quake/three.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use std::slice::Iter;
 use crate::GDResult;
 use crate::protocols::quake::two::{Player, QuakeTwo};
@@ -23,6 +23,6 @@ impl QuakeClient for QuakeThree {
     }
 }
 
-pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Player>> {
-    client_query::<QuakeThree>(address, port, timeout_settings)
+pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Player>> {
+    client_query::<QuakeThree>(address, timeout_settings)
 }

src/protocols/quake/two.rs

@@ -1,4 +1,4 @@
-use std::net::IpAddr;
+use std::net::SocketAddr;
 use std::slice::Iter;
 use crate::{GDError, GDResult};
 use crate::protocols::quake::one::QuakeOne;
@@ -47,6 +47,6 @@ impl QuakeClient for QuakeTwo {
     }
 }
 
-pub fn query(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Player>> {
-    client_query::<QuakeTwo>(address, port, timeout_settings)
+pub fn query(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Response<Player>> {
+    client_query::<QuakeTwo>(address, timeout_settings)
 }

src/protocols/valve/protocol.rs

@@ -30,7 +30,7 @@ use bzip2_rs::decoder::Decoder;
 
 use crate::protocols::valve::Packet;
 use std::collections::HashMap;
-use std::net::IpAddr;
+use std::net::SocketAddr;
 
 #[derive(Debug)]
 #[allow(dead_code)] //remove this later on
@@ -125,8 +125,8 @@ pub(crate) struct ValveProtocol {
 static PACKET_SIZE: usize = 6144;
 
 impl ValveProtocol {
-    pub fn new(address: &IpAddr, port: u16, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
-        let socket = UdpSocket::new(address, port)?;
+    pub fn new(address: &SocketAddr, timeout_settings: Option<TimeoutSettings>) -> GDResult<Self> {
+        let socket = UdpSocket::new(address)?;
         socket.apply_timeout(timeout_settings)?;
 
         Ok(Self { socket })
@@ -412,8 +412,7 @@ impl ValveProtocol {
 /// (GatherSettings::[default](GatheringSettings::default),
 /// TimeoutSettings::[default](TimeoutSettings::default)).
 pub fn query(
-    address: &IpAddr,
-    port: u16,
+    address: &SocketAddr,
     engine: Engine,
     gather_settings: Option<GatheringSettings>,
     timeout_settings: Option<TimeoutSettings>,
@@ -421,7 +420,6 @@ pub fn query(
     let response_gather_settings = gather_settings.unwrap_or_default();
     get_response(
         address,
-        port,
         engine,
         response_gather_settings,
         timeout_settings,
@@ -429,13 +427,12 @@ pub fn query(
 }
 
 fn get_response(
-    address: &IpAddr,
-    port: u16,
+    address: &SocketAddr,
     engine: Engine,
     gather_settings: GatheringSettings,
     timeout_settings: Option<TimeoutSettings>,
 ) -> GDResult<Response> {
-    let mut client = ValveProtocol::new(address, port, timeout_settings)?;
+    let mut client = ValveProtocol::new(address, timeout_settings)?;
 
     let info = client.get_server_info(&engine)?;
     let protocol = info.protocol;