rsfitsio 0.462.2

Rust bindings for the CFITSIO library, providing access to FITS files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# Contributing to rsfitsio

`rsfitsio` welcomes contributions from everyone

## PR Checking

1. Make sure tests pass
2. Run `cargo fmt`
3. Run `cargo fix`
4. Fix new warnings
5. Keep PRs small, and if required split into multiple explainable commits
6. Add tests

## Aims

Initially we are trying to stay close to the `cfitsio` implementation so that its easier to sync fixes. 

This means usage the same function names, variable names, parameter order, etc. In time this will be relaxed.

## Testing

Testing is still very limited and automated testing vs the C-API still needs to be added. In the meantime, it is suggested to compile and run testprog.c and verify that the output matches.

Both diffs should return not differences at all.

```
export LD_LIBRARY_PATH=~/rsfitsio/target/debug

gcc -L ../target/debug -o testprog testprog.c -lrsfitsio

./testprog > out.log

diff out.log testprog.out

diff testprog.fit testprog.std
```

## Sync'ing upstream

Updated `SYNCED_COMMIT.md` file with the commit hash of the upstream cfitsio library when you are syncing.

# Tips

## Testprog

```
cargo run --bin testprog > rust_testprog.lis
```

## Windows

```Powershell
$env:Path += ';C:\code\rsfitsio\target\debug'
```

## Miri

```
RUST_BACKTRACE=1 MIRIFLAGS="-Zmiri-env-forward=RUST_BACKTRACE -Zmiri-disable-isolation -Zmiri-backtrace=full" cargo miri test -- -- tests::test_write_image

MIRIFLAGS="-Zmiri-disable-isolation" cargo miri test

RUST_BACKTRACE=1 MIRIFLAGS="-Zmiri-env-forward=RUST_BACKTRACE -Zmiri-disable-isolation -Zmiri-backtrace=full" cargo miri run --bin testprog
```