Merge pull request #4 from newpavlov/master

Rustfmt, link to docs and minor improvements

Author: Osspial

Cargo.toml

@@ -1,13 +1,17 @@
 [package]
 name = "hidapi"
-version = "0.3.0"
-authors = ["Roland Ruckerbauer <[email protected]>", "Osspial <[email protected]", "Artyom Pavlov <[email protected]>"]
+version = "0.3.1"
+authors = [
+    "Roland Ruckerbauer <[email protected]>",
+    "Osspial <[email protected]>",
+    "Artyom Pavlov <[email protected]>"]
 repository = "https://github.com/Osspial/hidapi-rs"
 description = "Rust-y wrapper around hidapi"
 license = "LGPL-3.0+"
-keywords = ["hid", "api", "binding"]
+keywords = ["hid", "api", "usb","binding", "wrapper"]
 build = "build.rs"
 links = "hidapi"
+documentation = "https://beta.docs.rs/hidapi"
 
 [dependencies]
 libc = "0.2.15"

license.txt renamed to LICENSE.txt

@@ -1,19 +1,19 @@
-# hidapi
+# hidapi [![Build Status](https://travis-ci.org/Osspial/hidapi-rs.svg?branch=master)](https://travis-ci.org/Osspial/hidapi-rs) [![Version](https://img.shields.io/crates/v/hidapi.svg)](https://crates.io/crates/hidapi) [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://github.com/Osspial/hidapi-rs/blob/master/LICENSE.txt) [![Documentation](https://docs.rs/hidapi/badge.svg)](https://docs.rs/hidapi)
 
 This crate provides a rust abstraction over the features of the C library
 [hidapi](https://github.com/signal11/hidapi) by signal11. Based off of
 [hidapi_rust](https://github.com/ruabmbua/hidapi_rust) by ruabmbua.
 
 # Usage
 
-This crate is [on crates.io](https://crates.io/crates/hidapi) and can be
+This crate is on [crates.io](https://crates.io/crates/hidapi) and can be
 used by adding `hidapi` to the dependencies in your project's `Cargo.toml`.
 
 ```toml
 [dependencies]
 hidapi = "0.3"
 ```
-Example:
+# Example
 
 ```rust
 extern crate hidapi;
@@ -40,4 +40,4 @@ println!("Wrote: {:?} byte(s)", res);
 ```
 
 # Documentation
-You can generate documentation by running `cargo doc` for this crate.
+Available at [docs.rs](https://docs.rs/hidapi).

README.md

@@ -1,21 +1,21 @@
-/****************************************************************************
-    Copyright (c) 2015 Roland Ruckerbauer All Rights Reserved.
-
-    This file is part of hidapi_rust.
-
-    hidapi_rust is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    hidapi_rust is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with hidapi_rust.  If not, see <http://www.gnu.org/licenses/>.
-****************************************************************************/
+// **************************************************************************
+// Copyright (c) 2015 Roland Ruckerbauer All Rights Reserved.
+//
+// This file is part of hidapi_rust.
+//
+// hidapi_rust is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// hidapi_rust is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with hidapi_rust.  If not, see <http://www.gnu.org/licenses/>.
+// *************************************************************************
 
 extern crate gcc;
 extern crate pkg_config;
@@ -28,28 +28,28 @@ fn main() {
 fn compile() {
     let mut config = gcc::Config::new();
     config.file("etc/hidapi/libusb/hid.c").include("etc/hidapi/hidapi");
-    let lib = pkg_config::find_library("libusb-1.0").unwrap();
+    let lib = pkg_config::find_library("libusb-1.0").expect("Unable to find libusb-1.0");
     for path in lib.include_paths {
-        config.include(path.to_str().unwrap());
+        config.include(path.to_str().expect("Failed to convert include path to str"));
     }
     config.compile("libhidapi.a");
 }
 
 #[cfg(target_os = "windows")]
 fn compile() {
     gcc::Config::new()
-            .file("etc/hidapi/windows/hid.c")
-            .include("etc/hidapi/hidapi")
-            .compile("libhidapi.a");
+        .file("etc/hidapi/windows/hid.c")
+        .include("etc/hidapi/hidapi")
+        .compile("libhidapi.a");
     println!("cargo:rustc-link-lib=setupapi");
 }
 
 #[cfg(target_os = "macos")]
 fn compile() {
     gcc::Config::new()
-            .file("etc/hidapi/mac/hid.c")
-            .include("etc/hidapi/hidapi")
-            .compile("libhidapi.a");
+        .file("etc/hidapi/mac/hid.c")
+        .include("etc/hidapi/hidapi")
+        .compile("libhidapi.a");
     println!("cargo:rustc-link-lib=framework=IOKit");
     println!("cargo:rustc-link-lib=framework=CoreFoundation");
 }

build.rs

@@ -1,21 +1,21 @@
-/****************************************************************************
-    Copyright (c) 2015 Osspial All Rights Reserved.
-
-    This file is part of hidapi-rs, based on hidapi_rust by Roland Ruckerbauer.
-
-    hidapi-rs is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    hidapi-rs is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with hidapi-rs.  If not, see <http://www.gnu.org/licenses/>.
-****************************************************************************/
+/// **************************************************************************
+/// Copyright (c) 2015 Osspial All Rights Reserved.
+///
+/// This file is part of hidapi-rs, based on hidapi_rust by Roland Ruckerbauer.
+///
+/// hidapi-rs is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// hidapi-rs is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with hidapi-rs.  If not, see <http://www.gnu.org/licenses/>.
+/// *************************************************************************
 
 // For documentation look at the corresponding C header file hidapi.h
 
@@ -44,26 +44,44 @@ extern "C" {
     pub fn hid_exit() -> c_int;
     pub fn hid_enumerate(vendor_id: c_ushort, product_id: c_ushort) -> *mut HidDeviceInfo;
     pub fn hid_free_enumeration(hid_device_info: *mut HidDeviceInfo);
-    pub fn hid_open(vendor_id: c_ushort, product_id: c_ushort, serial_number: *const wchar_t)
-            -> *mut HidDevice;
+    pub fn hid_open(vendor_id: c_ushort,
+                    product_id: c_ushort,
+                    serial_number: *const wchar_t)
+                    -> *mut HidDevice;
     pub fn hid_open_path(path: *const c_char) -> *mut HidDevice;
     pub fn hid_write(device: *mut HidDevice, data: *const c_uchar, length: size_t) -> c_int;
-    pub fn hid_read_timeout(device: *mut HidDevice, data: *mut c_uchar, length: size_t,
-            milleseconds: c_int) -> c_int;
+    pub fn hid_read_timeout(device: *mut HidDevice,
+                            data: *mut c_uchar,
+                            length: size_t,
+                            milleseconds: c_int)
+                            -> c_int;
     pub fn hid_read(device: *mut HidDevice, data: *mut c_uchar, length: size_t) -> c_int;
     pub fn hid_set_nonblocking(device: *mut HidDevice, nonblock: c_int) -> c_int;
-    pub fn hid_send_feature_report(device: *mut HidDevice, data: *const c_uchar, length: size_t)
-            -> c_int;
-    pub fn hid_get_feature_report(device: *mut HidDevice, data: *mut c_uchar, length: size_t)
-            -> c_int;
+    pub fn hid_send_feature_report(device: *mut HidDevice,
+                                   data: *const c_uchar,
+                                   length: size_t)
+                                   -> c_int;
+    pub fn hid_get_feature_report(device: *mut HidDevice,
+                                  data: *mut c_uchar,
+                                  length: size_t)
+                                  -> c_int;
     pub fn hid_close(device: *mut HidDevice);
-    pub fn hid_get_manufacturer_string(device: *mut HidDevice, string: *mut wchar_t,
-            maxlen: size_t) -> c_int;
-    pub fn hid_get_product_string(device: *mut HidDevice, string: *mut wchar_t, maxlen: size_t)
-            -> c_int;
-    pub fn hid_get_serial_number_string(device: *mut HidDevice, string: *mut wchar_t,
-            maxlen: size_t) -> c_int;
-    pub fn hid_get_indexed_string(device: *mut HidDevice, string_index: c_int,
-            string: *mut wchar_t, maxlen: size_t) -> c_int;
+    pub fn hid_get_manufacturer_string(device: *mut HidDevice,
+                                       string: *mut wchar_t,
+                                       maxlen: size_t)
+                                       -> c_int;
+    pub fn hid_get_product_string(device: *mut HidDevice,
+                                  string: *mut wchar_t,
+                                  maxlen: size_t)
+                                  -> c_int;
+    pub fn hid_get_serial_number_string(device: *mut HidDevice,
+                                        string: *mut wchar_t,
+                                        maxlen: size_t)
+                                        -> c_int;
+    pub fn hid_get_indexed_string(device: *mut HidDevice,
+                                  string_index: c_int,
+                                  string: *mut wchar_t,
+                                  maxlen: size_t)
+                                  -> c_int;
     pub fn hid_error(device: *mut HidDevice) -> *const wchar_t;
 }