Add comprehensive Rust documentation for ipstack

[Copilot]

• Add module-level documentation for main modules (stream, error, packet)
• Add documentation for public structs (IpStack, IpStackConfig, IpStackStream variants)
• Add documentation for public methods on IpStack and IpStackConfig
• Add documentation for IpStackStream methods (local_addr, peer_addr)
• Add documentation for TCP stream (IpStackTcpStream) and its public methods
• Add documentation for UDP stream (IpStackUdpStream) and its public methods
• Add documentation for Unknown transport stream and its public methods
• Add examples in documentation where appropriate
• Verify documentation builds without warnings
• Address code review feedback and refine documentation accuracy
• Change stream_sender to internal visibility (pub(crate))

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add documentations</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)

@SajjadPourali > Are you looking for the CMS system for writing tutorial?

I believe that it would be more effective to provide Rust documentation to make https://docs.rs/ipstack meaningful. In the future, when ipstack involves more improvements and complexities, we can provide a dedicated web page for tutorials.</comment_new>

Fixes #39

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Copilot]

Pull Request Overview

This PR adds comprehensive Rust documentation to make the docs.rs/ipstack documentation meaningful and useful for users. The documentation covers all public APIs with detailed explanations, examples, and appropriate docstring formatting.

Key changes:

• Added module-level and struct-level documentation for core types (IpStack, IpStackConfig, IpStackStream variants)
• Added method documentation with examples for all public APIs
• Added error type documentation with clear descriptions
• Included practical usage examples throughout

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/lib.rs	Added comprehensive documentation for IpStack, IpStackConfig and their methods with usage examples
src/error.rs	Added documentation for error types and the Result type alias
src/stream/mod.rs	Added documentation for IpStackStream enum and its methods
src/stream/tcp.rs	Added documentation for IpStackTcpStream with TCP-specific examples
src/stream/udp.rs	Added documentation for IpStackUdpStream with UDP-specific examples
src/stream/unknown.rs	Added documentation for IpStackUnknownTransport with protocol handling examples

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[ssrlive]

LGTM