tribufu/rust-gamedig
1
0
Fork 0
mirror of https://github.com/tribufu/rust-gamedig synced 2026-06-01 09:42:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: Improve doc-comments for ErrorKind (#186)

Browse source 
* Improve doc-comments for ErrorKind

* error: Improve ErrorKind::BadGame doc comment

* error: fmt ErrorKind doc comments
This commit is contained in:
Tom 2024-02-06 15:06:54 +00:00 • committed by GitHub
parent 175dcf6aa6
commit fd497764f8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
crates/lib/src/errors/kind.rs
View file

@ -12,7 +12,7 @@ pub enum GDErrorKind {
PacketBad, PacketBad,
/// Couldn't send the packet. /// Couldn't send the packet.
PacketSend, PacketSend,
/// Couldn't send the receive. /// Couldn't receieve data when it was expected.
PacketReceive, PacketReceive,
/// Couldn't decompress data. /// Couldn't decompress data.
Decompress, Decompress,
@ -20,11 +20,13 @@ pub enum GDErrorKind {
SocketConnect, SocketConnect,
/// Couldn't bind a socket. /// Couldn't bind a socket.
SocketBind, SocketBind,
/// Invalid input. /// Invalid input to the library.
InvalidInput, InvalidInput,
/// The server queried is not the queried game server. /// The server response indicated that it is a different game than the game
/// queried.
BadGame, BadGame,
/// Couldn't automatically query. /// Couldn't automatically query (none of the attempted protocols were
/// successful).
AutoQuery, AutoQuery,
/// A protocol-defined expected format was not met. /// A protocol-defined expected format was not met.
ProtocolFormat, ProtocolFormat,