Skip to content

Add support for building a static library #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 1, 2025
Merged

Add support for building a static library #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4493d60
Add support for building a static library
onethumb Sep 1, 2025
b9c011e
Update README
onethumb Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ rust-version = "1.81"

[lib]
name = "crc_fast"
crate-type = ["lib", "cdylib"]
crate-type = ["lib", "cdylib", "staticlib"]
bench = true

[dependencies]
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ So I wrote one. :)

## Other languages

Supplies a [C/C++ compatible shared library](#cc-compatible-shared-library) for use with other non-`Rust` languages.
Supplies a [C/C++ compatible library](#cc-compatible-library) for use with other non-`Rust` languages.

## Implementations

Expand All @@ -39,8 +39,7 @@ See [CHANGELOG](CHANGELOG.md).
## Build & Install

`cargo build` will obviously build the library, including
the [C-compatible shared library](#c-compatible-shared-library). There are fine-tuning [feature flags](Cargo.toml)
available, should they be necessary for your deployment and [acceleration](#acceleration-targets) targets.
the [C-compatible library](#cc-compatible-library).

A _very_ basic [Makefile](Makefile) is supplied which supports `make install` to install the shared library and header
file to
Expand Down Expand Up @@ -248,11 +247,12 @@ let checksum = checksum_file_with_params(custom_params, file_on_disk, None);
assert_eq!(checksum.unwrap(), 0xcbf43926);
```

## C/C++ compatible shared library
## C/C++ compatible library

`cargo build` will produce a shared library target (`.so` on Linux, `.dll` on Windows, `.dylib` on macOS, etc) and an
auto-generated [libcrc_fast.h](libcrc_fast.h) header file for use in non-Rust projects, such as through
[FFI](https://en.wikipedia.org/wiki/Foreign_function_interface).
[FFI](https://en.wikipedia.org/wiki/Foreign_function_interface). It will also produce a static library target (`.a` on Linux and macOS, `.lib` on Windows, etc) for projects
which prefer statically linking.

There is a [crc-fast PHP extension](https://github.com/awesomized/crc-fast-php-ext) using it, for example.

Expand Down
Loading