[rustc.git] / vendor / adler / README.md

# Adler-32 checksums for Rust

[![crates.io](https://img.shields.io/crates/v/adler.svg)](https://crates.io/crates/adler)
[![docs.rs](https://docs.rs/adler/badge.svg)](https://docs.rs/adler/)
![CI](https://github.com/jonas-schievink/adler/workflows/CI/badge.svg)

This crate provides a simple implementation of the Adler-32 checksum, used in
the zlib compression format.

Please refer to the [changelog](CHANGELOG.md) to see what changed in the last
releases.

## Features

- Permissively licensed (0BSD) clean-room implementation.
- Zero dependencies.
- Zero `unsafe`.
- Decent performance (3-4 GB/s).
- Supports `#![no_std]` (with `default-features = false`).

## Usage

Add an entry to your `Cargo.toml`:

```toml
[dependencies]
adler = "1.0.2"
```

Check the [API Documentation](https://docs.rs/adler/) for how to use the
crate's functionality.

## Rust version support

Currently, this crate supports all Rust versions starting at Rust 1.31.0.

Bumping the Minimum Supported Rust Version (MSRV) is *not* considered a breaking
change, but will not be done without good reasons. The latest 3 stable Rust
versions will always be supported no matter what.
Commit	Line	Data
3dfed10e XL	1	# Adler-32 checksums for Rust
	2
	3	[![crates.io](https://img.shields.io/crates/v/adler.svg)](https://crates.io/crates/adler)
	4	[![docs.rs](https://docs.rs/adler/badge.svg)](https://docs.rs/adler/)
	5	![CI](https://github.com/jonas-schievink/adler/workflows/CI/badge.svg)
	6
	7	This crate provides a simple implementation of the Adler-32 checksum, used in
6a06907d	8	the zlib compression format.
3dfed10e XL	9
	10	Please refer to the [changelog](CHANGELOG.md) to see what changed in the last
	11	releases.
	12
	13	## Features
	14
	15	- Permissively licensed (0BSD) clean-room implementation.
	16	- Zero dependencies.
6a06907d	17	- Zero `unsafe`.
3dfed10e XL	18	- Decent performance (3-4 GB/s).
	19	- Supports `#![no_std]` (with `default-features = false`).
	20
	21	## Usage
	22
	23	Add an entry to your `Cargo.toml`:
	24
	25	```toml
	26	[dependencies]
6a06907d	27	adler = "1.0.2"
3dfed10e XL	28	```
	29
	30	Check the [API Documentation](https://docs.rs/adler/) for how to use the
	31	crate's functionality.
	32
	33	## Rust version support
	34
	35	Currently, this crate supports all Rust versions starting at Rust 1.31.0.
	36
	37	Bumping the Minimum Supported Rust Version (MSRV) is not considered a breaking
	38	change, but will not be done without good reasons. The latest 3 stable Rust
	39	versions will always be supported no matter what.