cberner / raptorq

Rust implementation of RaptorQ (RFC6330)
Apache License 2.0
264 stars 47 forks source link

Documentation #159

Closed emiliopaolini closed 5 months ago

emiliopaolini commented 9 months ago

Hi all,

i am trying to use the library with python bindings. However i am finding some issues and I cannot find a documentation in which the methods available are described. Is there one? Even if it is for rust, it is good!

cberner commented 9 months ago

https://docs.rs/raptorq/latest/raptorq/

There is some documentation for the Rust lib there

Sent from my phone

On Mon, Dec 4, 2023, 1:50 PM emiliopaolini @.***> wrote:

Hi all,

i am trying to use the library with python bindings. However i am finding some issues and I cannot find a documentation in which the methods available are described. Is there one? Even if it is for rust, it is good!

— Reply to this email directly, view it on GitHub https://github.com/cberner/raptorq/issues/159, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGNXQA6RZWRJZSC4XGVELDYHZATHAVCNFSM6AAAAABAGVMWW2VHI2DSMVQWIX3LMV43ASLTON2WKOZSGAZDIOBSGE4TQNA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

emiliopaolini commented 8 months ago

Thank you for the information. I have another concerns: when i build the encoder, I call get_encoded_packets(x), what is x? From the doc, i can see it says: repair_packets_per_block, but what does it actually mean? Thanks!

cberner commented 8 months ago

It's the number of unique repair packets that you will get