Initial rustdocs (#67)

Author: puffyCid

.changes/unreleased/Added-20250225-004526.yaml

@@ -0,0 +1,9 @@
+## v0.2.0 - 2025-03-30
+### Added
+* Support for parsing StateDump Protobuf data
+### Changed
+* Updated dependencies and migrated to Rust 2024 edition
+* Made log_type and event_type enums
+* Improved handling of log number data marked as private
+* Moved to HashMap instead of Vec for UUIDText and dsc parsing
+* Only keep a small cache of UUID strings instead of all strings. Should reduce memory usage quite a bit

.changes/unreleased/Changed-20250224-233352.yaml

@@ -6,4 +6,12 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
 
-No releases yet, this file will be updated when generating your first release.
+## v0.2.0 - 2025-03-30
+### Added
+* Support for parsing StateDump Protobuf data
+### Changed
+* Updated dependencies and migrated to Rust 2024 edition
+* Made log_type and event_type enums
+* Improved handling of log number data marked as private
+* Moved to HashMap instead of Vec for UUIDText and dsc parsing
+* Only keep a small cache of UUID strings instead of all strings. Should reduce memory usage quite a bit

.changes/unreleased/Changed-20250224-233435.yaml

@@ -32,7 +32,7 @@ Data that is currently extracted includes:
 
 An example binary is available to download
 
-- `unifiedlog_iterator` - Can parse a logarchive into a JSOL or CSV file. It can also run
+- `unifiedlog_iterator` - Can parse a logarchive into a JSOL or CSV file. It can also parse the logs
   on a live system. The output file will be quite large
 
 ## Limitations
@@ -43,7 +43,7 @@ the Unified Log format there are some limitations:
 1. No printf style error code lookup support. This library does not do any error
    code lookups for log messages. The native `log` command on macOS supports
    error code lookups when it encounters printf style `%m` messages.\
-   An example base log messsage: 'Failed to open file, error: %m'\
+   For example the log message: 'Failed to open file, error: %m'\
    a. This Library outputs:
    ```
    Failed to open file, error: 1
@@ -53,12 +53,11 @@ the Unified Log format there are some limitations:
    Failed to open file, error: no such file or directory
    ```
 
-2. Support for most custom objects in log messages. However, some objects are
-   not supported. Unsupported objects will be base64 encoded
+2. This library supports most custom objects in log messages. However, unsupported objects will be base64 encoded
 
 # References
 
-https://github.com/ydkhatri/UnifiedLogReader\
-https://github.com/libyal/dtformats/blob/main/documentation/Apple%20Unified%20Logging%20and%20Activity%20Tracing%20formats.asciidoc\
-https://eclecticlight.co/2018/03/19/macos-unified-log-1-why-what-and-how/\
-https://www.crowdstrike.com/blog/how-to-leverage-apple-unified-log-for-incident-response/
+- https://github.com/ydkhatri/UnifiedLogReader
+- https://github.com/libyal/dtformats/blob/main/documentation/Apple%20Unified%20Logging%20and%20Activity%20Tracing%20formats.asciidoc
+- https://eclecticlight.co/2018/03/19/macos-unified-log-1-why-what-and-how
+- https://www.crowdstrike.com/blog/how-to-leverage-apple-unified-log-for-incident-response