Add packet capture functionality and many more CLI improvements

[Douile]

Continuation of #162.

Adds packet capture functionality to the CLI without the need for external tools (like wireshark).

[cainthebest]

This PR is looking really good, I think setting some goals for this will mark the process toward this being ready.

• [x] Documentation
  • [x] Internal documentation for developers, explaining the source code.
  • [x] Comprehensive end-user documentation for the CLI interface.
  • [x] Functionality
  • [x] Working :)
  • [x] Add support for multiple data interchange formats.
  • [x] Design the library so that capture functionality is not included by default.
  • [x] Implement custom socket wrapping in the capture module.
  • [x] Achieve a high level of accuracy in emulating missing packets for pcap. (Known issue, added to docs)
  • [x] Avoid the use of unsafe code practices.
• [x] Optimizations
  • [x] Use fat LTO
  • [x] Remove debug symbols to streamline the binary.
  • [x] Adjust code generation units to 1 for optimization.
  • [x] Have a reasonable binary size (Currently ~2.3MB)
  • [x] Look into specific compiler flags suitable for different architectures/OS. (Not planned in this PR)
• [x] Release workflow
  • [x] Make the release accessible as possible with GitHub release (Not planned in this PR)
  • [x] Pre-build binaries for major architectures/OS.
  • [x] Set up an automated job to attach binaries with checksums to each release event.

[Douile]

Remove debug symbols to streamline the binary.

I'm not sure that we should do this, debugging symbols are very useful if something goes wrong. Although maybe we could use split-debugging symbols. (stripping got the binary down to 2.5M from 5.3M on my release binary).

Look into specific compiler flags suitable for different architectures/OS.

I'm not sure this is necessary for this PR but more of a stretch goal.

Achieve a high level of accuracy in emulating missing packets for pcap.

Could you elaborate more on what we're currently missing (sorry I wrote this code a while ago).

Everything else LGTM! :rocket:

[cainthebest]

I'm not sure that we should do this, debugging symbols are very useful if something goes wrong. Although maybe we could use split-debugging symbols. (stripping got the binary down to 2.5M from 5.3M on my release binary).

Im not that familiar on this usage in release but I think it worth looking into as its close to 50% of the size, we can always compile the build with them.

I'm not sure this is necessary for this PR but more of a stretch goal.

yeah that true, will remove from the list

Could you elaborate more on what we're currently missing (sorry I wrote this code a while ago).

Well you could say nothing is missing but currently the emulation isn't quite right. I don't think its a big issue as we can see that they are generated.

Was mentioned here https://github.com/gamedig/rust-gamedig/pull/162#issuecomment-1893615956

Edit: I think we can mark this as a known issue on merge

[cainthebest]

I'm holding of pushing anything ATM because I don't want to conflict with any local changes you might have.

Feel free to push, I have been testing the workflow from a different repo

[cainthebest]

I think this is now at the edge of the scope for this PR, we have a few things we can improve at a later date but we have made the goal of the functionality we set out. As this is quite a big change I have requested a review, pls feel free to nitpick

[cainthebest]

Had another look over and LGTM, are you happy to merge this @CosminPerRam ?

[CosminPerRam]

Hell yeah! I'll let you guys do the honor (: