All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

• Support for vector data-types in reading and writing tables.
• Option to use CMake instead of Autotools when building CFITSIO (fitsio-src feature + src-cmake feature)

• Miscellaneous ABI-related fixes, especially for 64-bit values on some 32-bit architectures

• Support for n-d arrays (rather than just 2-d arrays) #233

• Updated bindgen to version 0.63.0
• The bindgen feature is now implemented in fitsio-sys rather than fitsio. This is done as the bindings generation is really part of fitsio-sys rather than fitsio. There should be no external difference noticed.

• fitsio-sys-bindgen is no longer used. It has been merged with fitsio-sys.

• fitsio: update versions of fitsio-sys and fitsio-sys-bindgen to pick up latest changes
• fitsio-sys: do not specify the version for msys2 since it is not well represented

• The abillity to create a FitsFile struct from a fitsio_sys::fitsfile pointer #195
• Support for boolean header card values
• fitsio-sys (whichever feature is used) is exposed as fitsio::sys to make sure that only one crate that links to the system library exists #195

• BREAKING CHANGE the previously public field filename on FitsFile has been removed, since:
  • it is now optional,
  • it is not used internally for much, and
  • it is state that does not need to be part of fitsio. #195
• Some more types are deriving Eq thanks to a clippy lint
• Fixed broken tests on m1 macos #174
• Minimum cfitsio version of 3.37 specified for compilation #184

• Initial support for windows msys2 #150

• Specify version dependencies more specifically which should make installations more reliable, see this post #151
• Pin ndarray against versions 0.15.*. This prevents downstream users from having interoperability problems when ndarray updates to 0.16.0.

• Added support for 16 bit images and tables thanks @emaadparacha #148.

• arm32 architectures are tested on CI so consider arm32 a tier 1 platform - fitsio will not release a new version without arm32 tests passing on CI.

• Added support for arm32 architectures (armv7-unknown-linux-gnueabihf - e.g. Raspberry Pi). This is not tested on CI so it's not maintained as such.

• Added support for compiling cfitsio from source rather than using the bundled version. This requires the installer needing to include the dependencies that are required for installing cfitsio, namely make and gcc, thanks @cjordan. #130

• (fitsio-derive) corrected path to FitsHdu, release v0.2.0

• (fitsio) expose the HDU number (number) in the FitsHdu struct
• (fitsio) handle the 'X' fits column data type. This may not match the behaviour with cfitsio, but that behaviour is also seemingly complicated and suboptimal; see #122 for discussion.

• (fitsio) many small things, including using Rust 2018 edition.

• (fitsio) BREAKING CHANGE: implementing underlying raw fitsfile pointer as a std::ptr::NonNull, meaning the pointer is guaranteed to never be null, increasing the safety of the API. The breaking change is that more methods require a mutable (exclusive) reference (due to the method of converting the NonNull to mutable pointer, required by some lower level methods). The upside is that the FitsFile object should have exclusive access as it wraps the state of the fits file on disk. Safe concurrent (though not parallel) access is given by the threadsafe method.

• (fitsio) add boolean column type
• (fitsio) add threadsafe version of a FitsFile #99
• (fitsio) add benchmarking #98
• (fitsio) add support for writing all integer header keys

• (fitsio) fix errors with the system allocator, ensuring the package will run on the latest nightly and beta compilers #100

• (fitsio) add overwrite method to NewFitsFile #94
• (fitsio) add ndarray support #92
• (fitsio) add lots of documentation

• (fitsio) BREAKING CHANGE: move code into more logical submodule arrangement #95
• (fitsio) add long cfitsio function names internally #88

• (fitsio) add row method to read single row. This allows the user to declare a custom struct representing the row values #86
• (fitsio) add pretty-printing support #83
• (fitsio) add primary_hdu method #77

• (fitsio) BREAKING CHANGE: changed ImageType variants to be more rusty #84
• (fitsio) create_image and create_table take Into<String> #81
• (fitsio) WritesKey::write_key now accepts &str's as well as Strings #80
• (fitsio) BREAKING CHANGE: all ranges are now exclusive of the upper value, matching Rust's default behaviour #61
• (fitsio) BREAKING CHANGE: inverted the order of image/region axes to match the C row-major convention #59

Fix issue with uploading crate

• (fitsio) add support for images which are not 2d
• (fitsio) add support for customising the primary HDU when a file is created (Thanks @astrojhgu from the users discourse, for the suggestion)
• (fitsio) add support for non-2d images
• (fitsio) more friendly errors when image data is requested outside of the range of the image

• (fitsio) change function arguments that were previously start and end to a range Range<usize>
• (fitsio) removed builder pattern for construction of ColumnDataDescription
• (fitsio) some implementations which were previously nightly-only have been used. These features involve the cloned method on an Iterator. Therefore the version of rust is therefore restricted by this.

• (fitsio) Fixed problem with writing string columns

• (fitsio) Updated the documentation to be feature complete as of this version

• (fitsio) add iter #46
• (fitsio) add hdu_name, hdu_names, num_hdus, and delete #45
• (fitsio) add copy_to #44
• (fitsio) add insert_column, append_column, and delete_column methods to FitsHdu #43
• add contribution guide
• cfitsio license

• (fitsio) BREAKING CHANGE: most methods require passing a mutable FitsFile to perform work
• (fitsio) Include SBYTE_IMG, USHORT_IMG and ULONG_IMG data types

Nothing

• (fitsio) Created unified error type fitsio::errors::Error
• (fitsio) Official (i.e. tested) support for the extended filename syntax
• (fitsio) Implemented support for generating the ffi bindings "live" using bindgen #34
• (fitsio) Support (unsafely) accessing the underlying fitsfile pointer #32
• (fitsio) Implement resizing images #31

• (fitsio) Removed most unneeded unwraps from the code
• (fitsio) Simplified the implementation of buf_to_string
• (fitsio) Include image data type in hdu info struct

Nothing

vim: ft=markdown:textwidth=0:nocindent