Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to rust-zmq
# Contributing to zmq2

Thank you for your interest in contributing to rust-zmq!
Thank you for your interest in contributing to zmq2!

## Bug reports

Expand All @@ -23,7 +23,7 @@ that need to be considered when tackling the feature.

## Pull requests

rust-zmq uses the "fork and pull" model [described
zmq2 uses the "fork and pull" model [described
here](https://help.github.com/en/articles/about-collaborative-development-models). It
is highly recommended that you create a dedicated branch in your
repository for each pull request you submit, instead of submitting
Expand All @@ -33,7 +33,7 @@ avoid rewriting history on your fork's `master` branch (see below).

### Version history

The rust-zmq project aims to keep the version history useful and
The zmq2 project aims to keep the version history useful and
reasonably simple. Thus, when preparing and updating your pull
request, you should make liberal use of git's history rewriting
capabilities, such as amending and squashing commits. Try to observe
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ license = "MIT/Apache-2.0"
description = "Maintained high-level bindings to the zeromq library"
keywords = ["bindings", "protocol"]
categories = ["api-bindings", "network-programming"]
repository = "https://github.com/erickt/rust-zmq"
repository = "https://github.com/Traverse-Research/zmq2"
readme = "README.md"
build = "build.rs"
edition = "2018"
Expand Down
8 changes: 4 additions & 4 deletions HACKING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Hacking on rust-zmq
# Hacking on zmq2

This file is intended to collect useful knowledge when hacking on the
rust-zmq crate.
zmq2 crate.

If you intend to provide a contribution, please check the
[contribution guidelines].
Expand All @@ -10,13 +10,13 @@ If you intend to provide a contribution, please check the

## Regenerating the C bindings

The C low-level, unsafe C binding is provided by the `zmq-sys` crate,
The C low-level, unsafe C binding is provided by the `zmq-sys2` crate,
also hosted in this repository. The bindings are only partially
auto-generated, to allow getting some platform-specific details
right.

The autogenerated part produced by the `bindgen` crate is stored in
the [`ffi.rs`] file inside the `zmq-sys` crate, and is created using
the [`ffi.rs`] file inside the `zmq-sys2` crate, and is created using
the `zmq.h` header file; using the following command:

```sh
Expand Down
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,34 @@
Rust ZeroMQ bindings.
# Rust ZeroMQ bindings

[![Travis Build Status](https://travis-ci.org/erickt/rust-zmq.png?branch=master)](https://travis-ci.org/erickt/rust-zmq)
[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/xhytsx4jwyb9qk7m?svg=true)](https://ci.appveyor.com/project/erickt/rust-zmq)
[![Coverage Status](https://coveralls.io/repos/erickt/erickt-zmq/badge.svg?branch=master)](https://coveralls.io/r/erickt/erickt-zmq?branch=master)
[![Build Status](https://github.com/Traverse-Research/zmq2/workflows/Continuous%20integration/badge.svg)](https://github.com/Traverse-Research/zmq2/actions)
[![Apache 2.0 licensed](https://img.shields.io/badge/license-Apache2.0-blue.svg)](./LICENSE-APACHE)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE-MIT)
[![crates.io](http://meritbadge.herokuapp.com/zmq)](https://crates.io/crates/zmq)
[![docs](https://docs.rs/zmq/badge.svg)](https://docs.rs/zmq)
[![crates.io](https://img.shields.io/crates/v/zmq2.svg)](https://crates.io/crates/zmq2)
[![docs](https://docs.rs/zmq2/badge.svg)](https://docs.rs/zmq2)

[Documentation](https://docs.rs/crate/zmq/)
[Release Notes](https://github.com/Traverse-Research/zmq2/releases)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🦗


[Release Notes](https://github.com/erickt/rust-zmq/tree/master/NEWS.md)

# About
## About

The `zmq2` crate provides bindings for the `libzmq` library from the
[ZeroMQ](https://zeromq.org/) project. This project is a fork of the
[ZeroMQ](https://zeromq.org/) project. This project is a fork of the
[https://github.com/erickt/rust-zmq](rust-zmq) project, with the intent
of keeping it actively maintained.

This project removes the `cmake` dependency of this project, as well as
update the dependencies. It has also removed the `pkgconfig` build in
favor of always building a vendored version of this library.

# Compatibility
## Compatibility

The aim of this fork is to track latest zmq releases as close as possible,
while in the beginning aming to be a drop in replacement of the original
The goal of this fork is to track latest zmq releases as close as possible,
while in the beginning aiming to be a drop-in replacement of the original
`zmq` library. Though over time we'll most likely abandon that, in favor
of our own library features.

# Usage
## Usage

`zmq2` is a pretty straight forward port of the C API into Rust:
`zmq2` is a pretty straightforward port of the C API into Rust:

```rust
fn main() {
Expand All @@ -47,7 +43,7 @@ fn main() {
You can find more usage examples in
https://github.com/Traverse-Research/zmq2/tree/master/examples.

# Contributing
## Contributing

Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the
Expand Down
2 changes: 1 addition & 1 deletion examples/zguide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The coding guidelines for porting examples is:
the bindings. We want these to also highlight the differences in API
usage and the higher-level abstractions provided, if applicable.

Besides giving potential rust-zmq users an impression of the bindings,
Besides giving potential zmq2 users an impression of the bindings,
these examples are also intended as a "proving ground" for API
additions and changes. Ideally, an API change should be reflected in
changes to the examples that improve code quality (by whatever
Expand Down
2 changes: 1 addition & 1 deletion src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use super::errno_to_error;
/// sent over the wire. Multipart messages are transmitted as multiple
/// `Message`s.
///
/// In rust-zmq, you aren't required to create message objects if you use the
/// In zmq2, you aren't required to create message objects if you use the
/// convenience APIs provided (e.g. `Socket::recv_bytes()` or
/// `Socket::send()`). However, using message objects can make multiple
/// operations in a loop more efficient, since allocated memory can be reused.
Expand Down
2 changes: 1 addition & 1 deletion zmq-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ license = "MIT/Apache-2.0"
description = "Low-level bindings to the zeromq library"
keywords = ["ffi", "bindings"]
categories = ["external-ffi-bindings"]
repository = "https://github.com/erickt/rust-zmq"
repository = "https://github.com/Traverse-Research/zmq2"
build = "build/main.rs"
links = "zmq"

Expand Down