Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoodie/sdp-nom
⚓️ i=a wasm friendly SDP parser
https://github.com/hoodie/sdp-nom
sdp wasm webrtc
Last synced: about 2 months ago
JSON representation
⚓️ i=a wasm friendly SDP parser
- Host: GitHub
- URL: https://github.com/hoodie/sdp-nom
- Owner: hoodie
- License: apache-2.0
- Created: 2019-03-10T21:18:27.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-12-17T10:48:39.000Z (about 2 years ago)
- Last Synced: 2024-10-09T07:12:01.026Z (2 months ago)
- Topics: sdp, wasm, webrtc
- Language: Rust
- Homepage:
- Size: 253 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-Apache
Awesome Lists containing this project
README
# sdp-nom
[](https://github.com/hoodie/notify-rust/actions?query=workflow%3A"Continuous+Integration")
[](https://crates.io/crates/sdp-nom)
[](https://github.com/hoodie/sdp-nom/graphs/contributors)
[](https://crates.io/crates/sdp-nom/)
[](https://docs.rs/sdp-nom/)
[](https://crates.io/crates/sdp-nom/)
This is a [nom][]-based SDP parser.
It can parse and reserialize and is currently optimized for a very small wasm footprint (hence the use of [ufmt][]).
You don't need reserialization? Just build with `--no-default-features`.
## Why?
There is already [mozilla's webrtc-sdp][mozilla-sdp], [sdp from webrtc.rs][webrtc_rs] and [sdp-types],
which are all very good, why make another?
This is still very much a "for fun" project, so don't mind me!
## cargo-features
| name | what it does | default |
| -------- | --------------------------------------------- | ------- |
| udisplay | use [ufmt][] to reserialize session and lines | **yes** |
| debug | provide `Debug` formatting for all types | **yes** |
| serde | well serde support of course | no |
| wee | use [wee][] allocator | no |
## Objectives
With this parser we try to implement a wasm-friendly, low-copy and high-level-nom parser.
### WASM-Friendly
By using [wee][] and [ufmt][] we try to achieve a small binary size.
Further Debug-printing is a feature that can be disabled.
Further concrete wasm-related work is on the horizon.
### low copy
Zero copy seems a bit out of reach but this parser tries to enable as much as possible without actually copying over the content of the sdp.
This is achieved by reading any string into a [`Cow`][] and only optionally creating a `'static` copy of the content.
### functional high-level parser-combinators
SDP is a weird standard,
there is no container format specification other than that lines start with a `char` followed by `=`.
Basically every line follows it's own rules.
Therefore every line has its own parser like in this example:
```rust
/// Email `e=`
pub struct EmailAddress<'a>(pub Cow<'a, str>);
/// "[email protected]"
pub fn email_address_line(input: &str) -> IResult<&str, EmailAddress> {
line("e=", wsf(map(cowify(read_string), EmailAddress)))(input)
}
```
## License
icalendar-rs is licensed under either of
* Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Any help in form of descriptive and friendly [issues](https://github.com/hoodie/sdp-nom/issues) or comprehensive pull requests are welcome!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in sdp-nom by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
[nom]: https://docs.rs/nom
[ufmt]: https://docs.rs/ufmt
[wee]: https://docs.rs/wee_alloc
[mozilla-sdp]: https://crates.io/crates/webrtc-sdp
[webrtc_rs]: https://crates.io/crates/sdp
[sdp-types]: https://crates.io/crates/sdp-types
[`cow`]: https://doc.rust-lang.org/stable/std/borrow/enum.Cow.html