# `zfc`
[<img alt="git" src="https://git.philomathiclife.com/badges/zfc.svg" height="20">](https://git.philomathiclife.com/zfc/log.html)
[<img alt="crates.io" src="https://img.shields.io/crates/v/zfc.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/zfc)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-zfc-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/zfc/latest/zfc/)
`zfc` is a library for sets according to
[Zermelo–Fraenkel set theory with the axiom of choice (ZFC)](https://en.wikipedia.org/wiki/Zermelo%E2%80%93Fraenkel_set_theory).
## Minimum Supported Rust Version (MSRV)
This will frequently be updated to be the same as stable. Specifically, any time stable is updated and that
update has "useful" features or compilation no longer succeeds (e.g., due to new compiler lints), then MSRV
will be updated.
MSRV changes will correspond to a SemVer patch version bump pre-`1.0.0`; otherwise a minor version bump.
## SemVer Policy
* All on-by-default features of this library are covered by SemVer
* MSRV is considered exempt from SemVer as noted above
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](https://www.apache.org/licenses/LICENSE-2.0))
* MIT license ([LICENSE-MIT](https://opensource.org/licenses/MIT))
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.
Before any PR is sent, `cargo clippy --all-targets`, `cargo test --all-targets`, and `cargo test --doc` should be
run _for each possible combination of "features"_ using the stable and MSRV toolchains. One easy way to achieve this
is by invoking [`ci-cargo`](https://crates.io/crates/ci-cargo) as `ci-cargo clippy --all-targets test --all-targets`
in the `zfc` directory.
Last, `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features` should be run to ensure documentation can be
built.
### Status
The crate is only tested on the `x86_64-unknown-linux-gnu`, `x86_64-unknown-openbsd`, and `aarch64-apple-darwin`
targets; but it should work on most platforms.