[plum] About

Contributors

License

MIT License

Copyright (c) 2019 Daniel Mark Gass (dan.gass@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

What’s Next?

plum development is not done! Here are the major features being planned and worked on:

  • Improve documentation.

    • Add simple examples to reference pages.

  • Refine regression tests.

    • Add exception (user experience) test cases.

  • Add types.

    • IpAddr
    • MacAddr

  • Increase performance.

    The long term goal aims to rival performance of the struct standard library module, a difficult task given that struct is very lean and efficient.

    A complimentary plum-boost package exists to help achieve this goal. Currently the package offers an alternative versions of the unpack(), unpack_from(), pack() and pack_into() functions. These alternative implementations are implemented in “C” and accelerate packing and unpacking integers and structures.

    Currently the plum-boost package is not yet available.

  • Expand support for “views” of buffers.

    • For the remaining core plum types, develop associated “view” types.