Merge pull request #44 from rust-embedded/relax-extract-pin-from-path

Relax extract pin from path

Author: posborne

.travis.yml

@@ -1,7 +1,7 @@
 language: rust
 sudo: false
 rust:
-  - 1.20.0
+  - 1.21.0
   - stable
   - beta
   - nightly

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [master] - Unreleased
 
+## [0.5.3] - 2018-04-19
+
+### Fixed
+
+- Relaxed path restrictions on `Pin::from_path` to allow for directories
+  outside of `/sys/class/gpio`, required for some SOCs that symlink outside of
+  that directory.
+
 ## [0.5.2] - 2018-03-02
 
 ### Changed
@@ -158,7 +166,8 @@
 - Initial version of the library with basic functionality
 - Support for `export`/`unexport`/`get_value`/`set_value`/`set_direction`
 
-[master]: https://github.com/posborne/rust-sysfs-gpio/compare/0.5.2...master
+[master]: https://github.com/posborne/rust-sysfs-gpio/compare/0.5.3...master
+[0.5.3]: https://github.com/posborne/rust-sysfs-gpio/compare/0.5.2...0.5.3
 [0.5.2]: https://github.com/posborne/rust-sysfs-gpio/compare/0.5.1...0.5.2
 [0.5.1]: https://github.com/posborne/rust-sysfs-gpio/compare/0.5.0...0.5.1
 [0.5.0]: https://github.com/posborne/rust-sysfs-gpio/compare/0.4.4...0.5.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sysfs_gpio"
-version = "0.5.2"
+version = "0.5.3"
 authors = ["Paul Osborne <osbpau@gmail.com>"]
 license = "MIT/Apache-2.0"
 repository = "https://github.com/rust-embedded/rust-sysfs-gpio"

src/lib.rs

@@ -77,8 +77,6 @@ use tokio_core::reactor::{Handle, PollEvented};
 mod error;
 pub use error::Error;
 
-const GPIO_PATH_PREFIX: &'static str = "/sys/class/gpio/gpio";
-
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub struct Pin {
     pin_num: u64,
@@ -177,21 +175,17 @@ impl Pin {
                                           a directory"
                                                  .to_owned()));
         }
-        let num = Pin::extract_pin_from_path(&pb.to_str().unwrap_or(""))?;
+        let num = Pin::extract_pin_from_path(&pb)?;
         Ok(Pin::new(num))
     }
 
     /// Extract pin number from paths like /sys/class/gpio/gpioXXX
-    fn extract_pin_from_path(path: &str) -> Result<u64> {
-        if path.starts_with(GPIO_PATH_PREFIX) {
-            path.split_at(GPIO_PATH_PREFIX.len()).1.parse::<u64>().or(
-                Err(
-                    Error::InvalidPath(format!("{:?}", path)),
-                ),
-            )
-        } else {
-            Err(Error::InvalidPath(format!("{:?}", path)))
-        }
+    fn extract_pin_from_path<P: AsRef<Path>>(path: P) -> Result<u64> {
+        path.as_ref()
+            .file_name()
+            .and_then(|filename| filename.to_str())
+            .and_then(|filename_str| filename_str.trim_left_matches("gpio").parse::<u64>().ok())
+            .ok_or(Error::InvalidPath(format!("{:?}", path.as_ref())))
     }
 
     /// Get the pin number
@@ -483,14 +477,16 @@ impl Pin {
 
 #[test]
 fn extract_pin_fom_path_test() {
-    let tok = Pin::extract_pin_from_path(&"/sys/class/gpio/gpio951");
-    assert_eq!(951, tok.unwrap());
-    let err1 = Pin::extract_pin_from_path(&"/sys/is/error/gpio/gpio111");
+    let tok1 = Pin::extract_pin_from_path(&"/sys/class/gpio/gpio951");
+    assert_eq!(951, tok1.unwrap());
+    let tok2 = Pin::extract_pin_from_path(&"/sys/CLASS/gpio/gpio951/");
+    assert_eq!(951, tok2.unwrap());
+    let tok3 = Pin::extract_pin_from_path(&"../../devices/soc0/gpiochip3/gpio/gpio124");
+    assert_eq!(124, tok3.unwrap());
+    let err1 = Pin::extract_pin_from_path(&"/sys/CLASS/gpio/gpio");
     assert_eq!(true, err1.is_err());
-    let err2 = Pin::extract_pin_from_path(&"/sys/CLASS/gpio/gpio");
+    let err2 = Pin::extract_pin_from_path(&"/sys/class/gpio/gpioSDS");
     assert_eq!(true, err2.is_err());
-    let err3 = Pin::extract_pin_from_path(&"/sys/class/gpio/gpioSDS");
-    assert_eq!(true, err3.is_err());
 }
 
 #[derive(Debug)]