Code Monkey home page Code Monkey logo

net-bits's Introduction

net-bits

Blatantly forked from dzamlo's rust-bitfield

Modified

I've modified rust-bitfield a tiny bit to fit with chucker, my toy/pet network project, which has some wonky requirements. It seems a bit silly to somehow merge this with rust-bitfields, as I don't think the changes contribute anything to the common good. The description below still stands:

Original text

This project provides a procedural macro to generate bitfield-like struct.

The generated structs use an array of u8 for the data and provide methods to get and set the values of the fields.

The generatated structs are not compatible with C bitfield. Unlike in C, the position of each bytes and bits in the underling bytes array is specifed. The bytes are in network order, and the bits are MSB first. No padding is added.

Because the generated struct is just a normal struct, you can add other methods to it or implement the trait you want.

Possible use includes decoding some binary file formats and reading the headers of some network protocols or some low-level protocols.

Usage

To use with chucker.

Don't look at the examples folder for examples of the use the macro. Those examples were meant for rust-bitfields and are terribly broken at the moment.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

net-bits's People

Contributors

dzamlo avatar stuij avatar emberian avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.