Feat/cs/cleanup

[ReagentX]

• New features
  • Add primitives() to PropertyIterator
  • Add iter_root() shortcut to TypedStreamDeserializer to cut down on boilerplate
  • Implement Display and helper methods for OutputData
• Miscellaneous
  • Reorganize modules
  • Remove debug logs
  • Remove alpha warning
  • Update readme

[Copilot]

Pull Request Overview

This PR cleans up the codebase while adding two new features to simplify working with typed stream data: a new helpers method primitives() in PropertyIterator and an iter_root() shortcut for TypedStreamDeserializer. It also updates documentation, removes debug logs, and renames a module for clarity.

• Added new helper primitives() to extract primitive values from the deserialized object graph.
• Introduced iter_root() to streamline property resolution from the root object.
• Improved documentation, refactored module names, and removed debug print statements.

Reviewed Changes

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

Show a summary per file

File	Description
src/models/types.rs	Reformatted import grouping for cleaner code organization.
src/models/output_data.rs	Updated doc comments and implemented helper methods and Display trait.
src/models/mod.rs	Renamed module "archivable" to "archived" for clarity.
src/models/class.rs	Changed access level for Class::new and updated related docs.
src/models/archived.rs	Added clarifying documentation for archived objects.
src/lib.rs	Updated re-exports and removed obsolete debug/log comments.
src/error.rs	Enhanced documentation with code examples for error handling.
src/deserializer/typedstream.rs	Introduced iter_root(); removed debug println! statements; updated docs.
src/deserializer/string.rs	Minor doc comment updates regarding UTF-8 string reading.
src/deserializer/read.rs	Cleaned up import formatting and updated documentation references.
src/deserializer/number.rs	Adjusted import ordering and updated test module imports.
src/deserializer/mod.rs	Minor documentation update on module purpose.
src/deserializer/iter.rs	Added doc comments for the new primitives() method and improved examples.
src/deserializer/header.rs	Updated header validation docs for clarity.
README.md	Revised language and formatting for better clarity and presentation.