jonas-schievink/rubble

Try out `scroll` or `zerocopy` for de/encoding of PDUs

Open

#53 opened on Apr 28, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (403 stars) (58 forks)user submission
area: utilsgood first issuestatus: needs codetype: enhancement

Description

scroll allows deriving decoding and encoding traits, which is just what I want. We should try porting rubble to use that instead of bytes.rs.

We can also try out the zerocopy crate, which allows C-like reinterpretation of arbitrary bytes in safe Rust. Unfortunately it's near impossible to contribute to zerocopy since it's part of fuchsia, but it looks promising.

Contributor guide

Tech stack
rust
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programming basicsFamiliarity with the rubble repository
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the current `bytes.rs` file in the rubble repository to understand the existing PDU encoding/decoding. Then, add `scroll` as a dependency and attempt to derive `Pread` and `Pwrite` traits for relevant PDU types. Compare with the existing implementation and ensure existing tests pass. If issues arise, refer to the scroll documentation. Also consider trying the `zerocopy` crate, but note the contributor's comment about limited ability to contribute to it.