Auto merge of #421 - lennart/CLOUD-91, r=TroyKomodo

feat(amf0): serde rewrite
- Rewrite scuffle-amf0 with serde support
  - Adheres to these [conventions](https://serde.rs/conventions.html)

CLOUD-91

Requested-by: lennartkloock <[email protected]>
Reviewed-by: TroyKomodo <[email protected]>

Author: scuffle-brawl[bot]

Cargo.lock

@@ -0,0 +1,32 @@
+[[scuffle-amf0]]
+category = "feat"
+description = "rewrite with serde support"
+breaking = true
+authors = ["@lennartkloock", "@TroyKomodo"]
+
+[[scuffle-bytes-util]]
+category = "feat"
+description = "add new cow types"
+authors = ["@TroyKomodo", "@lennartkloock"]
+
+[[scuffle-bytes-util]]
+category = "feat"
+description = "add new zero-copy reader types"
+authors = ["@TroyKomodo", "@lennartkloock"]
+
+[[scuffle-flv]]
+category = "chore"
+description = "update to use new version of scuffle-amf0"
+breaking = true
+authors = ["@lennartkloock", "@TroyKomodo"]
+
+[[scuffle-rtmp]]
+category = "chore"
+description = "update to use new version of scuffle-amf0"
+breaking = true
+authors = ["@lennartkloock"]
+
+[[scuffle-transmuxer]]
+category = "chore"
+description = "update to use new version of scuffle-rtmp"
+authors = ["@lennartkloock"]

changes.d/pr-421.toml

@@ -11,10 +11,22 @@ keywords = ["amf0", "rtmp", "flash", "video", "flv"]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage_nightly)'] }
 
 [dependencies]
-bytes = "1.5"
+serde = { version = "1.0.219", optional = true }
+bytes = "1.10.1"
 byteorder = "1.5"
 num-traits = "0.2"
 num-derive = "0.4"
-scuffle-bytes-util.workspace = true
 thiserror = "2.0"
+bytestring = "1.4.0"
+scuffle-bytes-util = { workspace = true }
 scuffle-workspace-hack.workspace = true
+
+[dev-dependencies]
+serde = { version = "1.0.219", features = ["derive"] }
+
+[features]
+serde = ["dep:serde", "scuffle-bytes-util/serde"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/amf0/Cargo.toml

@@ -9,6 +9,37 @@
 
 A pure-rust implementation of AMF0 encoder and decoder.
 
+This crate provides serde support for serialization and deserialization of AMF0 data.
+
+## Specification
+
+| Name | Version | Link | Comments |
+| --- | --- | --- | --- |
+| Action Message Format -- AMF 0 | - | <https://rtmp.veriskope.com/pdf/amf0-file-format-specification.pdf> | Refered to as 'AMF0 spec' in this documentation |
+
+## Limitations
+
+- Does not support AMF0 references.
+- Does not support the AVM+ Type Marker. (see AMF 0 spec, 3.1)
+
+## Example
+
+```rust
+// Decode a string value from bytes
+let value: String = scuffle_amf0::from_bytes(bytes)?;
+
+// .. do something with the value
+
+// Encode a value into a writer
+scuffle_amf0::to_writer(&mut writer, &value)?;
+```
+
+## Status
+
+This crate is currently under development and is not yet stable.
+
+Unit tests are not yet fully implemented. Use at your own risk.
+
 ## License
 
 This project is licensed under the [MIT](./LICENSE.MIT) or [Apache-2.0](./LICENSE.Apache-2.0) license.