onelib 0.1.0

Rust implementation of the ONEcode file format
Documentation
BSD 3-Clause Licence

Original ONEcode format and C reference implementation:
Copyright (c) Richard Durbin, Cambridge University and Eugene Myers 2019-

This Rust implementation:
Copyright (c) 2026, Max Planck Institute for Evolutionary Anthropology

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

---

Acknowledgements

The ONEcode file format was designed by Gene Myers and Richard Durbin. The
canonical C reference implementation is available at:

  https://github.com/thegenemyers/ONEcode

This Rust library is an independent implementation of the ONEcode format
specification, developed with reference to the C library source code.

If you use this software in academic work, please cite:

  Myers G, Durbin R, Zhou C. FastGA: fast genome alignment.
  Bioinformatics Advances. 2025;5(1):vbaf238.
  https://doi.org/10.1093/bioadv/vbaf238