Merge pull request #12 from rust-embedded/use-str-over-string

posborne · posborne · commit 6efbed03273d · 2016-04-24T21:34:53.000-05:00
Use str over string
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # Linux GPIO Utils
 
+[![Build Status](https://travis-ci.org/rust-embedded/gpio-utils.svg?branch=master)](https://travis-ci.org/rust-embedded/gpio-utils)
+[![Version](https://img.shields.io/crates/v/gpio-utils.svg?maxAge=2592000)](https://crates.io/crates/gpio-utils)
+[![License](https://img.shields.io/crates/l/rustc-serialize.svg?maxAge=2592000)](https://github.com/rust-embedded/gpio-utils/blob/master/README.md#license)
+
 GPIO Utils provides convenient access to GPIOs on a Linux system. The library
 builds on top of the sysfs interface to GPIOs exposed by the kernel and provides
 essential functionality required for most embedded systems.
@@ -15,15 +19,15 @@ cargo install gpio-utils
 
 ## Features
 
-- [ ] Infrastructure for providing names for the GPIOs in one's system providing
+- [x] Infrastructure for providing names for the GPIOs in one's system providing
       names that map to individual pins.  These names (in addition to GPIO numbers)
       may be used with other commands.
-- [ ] Ability to export/unexport GPIOs and expose symlinks using the GPIO "friendly"
+- [x] Ability to export/unexport GPIOs and expose symlinks using the GPIO "friendly"
       names simpler.
-- [ ] Ability to set input/output state on each pin
-- [ ] Ability to get/set gpio values by pin number or name (including temporary
+- [x] Ability to set input/output state on each pin
+- [x] Ability to get/set gpio values by pin number or name (including temporary
       export if necessary)
-- [ ] Ability to block awaiting pin state change (with timeout)
+- [x] Ability to block awaiting pin state change (with timeout)
 
 ## System Integration
 
diff --git a/src/commands/gpio_export.rs b/src/commands/gpio_export.rs
@@ -12,7 +12,7 @@ use std::process::exit;
 use export;
 
 pub fn main(config: &GpioConfig, opts: &GpioExportOptions) {
-    let pin = match config.get_pin(&opts.pin[..]) {
+    let pin = match config.get_pin(opts.pin) {
         Some(pin) => pin,
         None => {
             println!("Unable to find config entry for pin '{}'", opts.pin);
@@ -21,7 +21,7 @@ pub fn main(config: &GpioConfig, opts: &GpioExportOptions) {
     };
 
     let symlink_root = match opts.symlink_root {
-        Some(ref slr) => &slr[..],
+        Some(slr) => slr,
         None => config.get_symlink_root(),
     };
 
diff --git a/src/commands/gpio_exportall.rs b/src/commands/gpio_exportall.rs
@@ -13,7 +13,7 @@ use export;
 
 pub fn main(config: &GpioConfig, opts: &GpioExportAllOptions) {
     let symlink_root = match opts.symlink_root {
-        Some(ref slr) => &slr[..],
+        Some(slr) => slr,
         None => config.get_symlink_root(),
     };
 
diff --git a/src/commands/gpio_poll.rs b/src/commands/gpio_poll.rs
@@ -13,15 +13,15 @@ use std::process::exit;
 
 pub fn main(config: &GpioConfig, opts: &GpioPollOptions) {
     let timeout = opts.timeout.unwrap_or(-1);
-    let pin_config = match config.get_pin(&opts.pin[..]) {
+    let pin_config = match config.get_pin(opts.pin) {
         Some(pin) => pin,
         None => {
             println!("Unable to find config entry for pin '{}'", opts.pin);
             exit(1)
         }
     };
     let pin = pin_config.get_pin();
-    let edge = match &opts.edge[..] {
+    let edge = match opts.edge {
         "rising" => Edge::RisingEdge,
         "falling" => Edge::FallingEdge,
         "both" => Edge::BothEdges,
diff --git a/src/commands/gpio_read.rs b/src/commands/gpio_read.rs
@@ -11,7 +11,7 @@ use config::GpioConfig;
 use std::process::exit;
 
 pub fn main(config: &GpioConfig, opts: &GpioReadOptions) {
-    let pin_config = match config.get_pin(&opts.pin[..]) {
+    let pin_config = match config.get_pin(opts.pin) {
         Some(pin) => pin,
         None => {
             println!("Unable to find config entry for pin '{}'", opts.pin);
diff --git a/src/commands/gpio_status.rs b/src/commands/gpio_status.rs
@@ -15,7 +15,7 @@ use std::process::exit;
 pub fn main(config: &GpioConfig, opts: &GpioStatusOptions) {
     match opts.pin {
         Some(ref pin_name) => {
-            let pin_config = match config.get_pin(&pin_name[..]) {
+            let pin_config = match config.get_pin(pin_name) {
                 Some(pin) => pin,
                 None => {
                     println!("Unable to find config entry for pin '{}'", pin_name);
@@ -24,7 +24,7 @@ pub fn main(config: &GpioConfig, opts: &GpioStatusOptions) {
             };
             print_pin_header();
             print_pin_row(&pin_config, true);
-        },
+        }
         None => {
             print_pin_header();
             for (pos, pin) in config.get_pins().iter().enumerate() {
@@ -35,20 +35,24 @@ pub fn main(config: &GpioConfig, opts: &GpioStatusOptions) {
 }
 
 
-fn print_pin_header(){
-    println!("| {:<10} | {:<10} | {:<10} | {:<10} | {:<10} | {:<10} |", 
-             "Number", 
-             "Exported", 
-             "Direction",  
-             "Active Low", 
-             "Names", 
+fn print_pin_header() {
+    println!("| {:<10} | {:<10} | {:<10} | {:<10} | {:<10} | {:<10} |",
+             "Number",
+             "Exported",
+             "Direction",
+             "Active Low",
+             "Names",
              "Value");
     print_row_sep(false);
 }
 
-fn print_row_sep(is_last: bool){
-    let col_sep = if is_last {"-"} else {"+"};
-    println!("{}{:->13}{:->13}{:->13}{:->13}{:->13}{:->13}", 
+fn print_row_sep(is_last: bool) {
+    let col_sep = if is_last {
+        "-"
+    } else {
+        "+"
+    };
+    println!("{}{:->13}{:->13}{:->13}{:->13}{:->13}{:->13}",
              col_sep,
              col_sep,
              col_sep,
@@ -58,7 +62,7 @@ fn print_row_sep(is_last: bool){
              col_sep);
 }
 
-fn print_pin_row(pin_config: &PinConfig, is_last: bool){
+fn print_pin_row(pin_config: &PinConfig, is_last: bool) {
     let direction = match pin_config.direction {
         Direction::In => "In",
         Direction::Out => "Out",
@@ -71,25 +75,25 @@ fn print_pin_row(pin_config: &PinConfig, is_last: bool){
         Err(e) => {
             println!("ERROR: {:?}", e);
             exit(1);
-        },
+        }
     };
 
     for (pos, name) in pin_config.names.iter().enumerate() {
         if pos == 0 {
-            println!("| {:<10} | {:<10} | {:<10} | {:<10} | {:<10} | {:<10} |", 
-                     pin_config.num, 
-                     pin_config.export, 
-                     direction, 
-                     pin_config.active_low, 
-                     name, 
+            println!("| {:<10} | {:<10} | {:<10} | {:<10} | {:<10} | {:<10} |",
+                     pin_config.num,
+                     pin_config.export,
+                     direction,
+                     pin_config.active_low,
+                     name,
                      value);
         } else {
-            println!("| {:<10} | {:<10} | {:<10} | {:<10} | {:<10} | {:<10} |", 
-                     "", 
-                     "", 
-                     "", 
-                     "", 
-                     name, 
+            println!("| {:<10} | {:<10} | {:<10} | {:<10} | {:<10} | {:<10} |",
+                     "",
+                     "",
+                     "",
+                     "",
+                     name,
                      "");
 
         }
diff --git a/src/commands/gpio_unexport.rs b/src/commands/gpio_unexport.rs
@@ -12,13 +12,13 @@ use std::process::exit;
 use export;
 
 pub fn main(config: &GpioConfig, opts: &GpioUnexportOptions) {
-    let pin_config = config.get_pin(&opts.pin[..]).unwrap_or_else(|| {
+    let pin_config = config.get_pin(opts.pin).unwrap_or_else(|| {
         println!("Unable to find config entry for pin '{}'", opts.pin);
         exit(1)
     });
 
     let symlink_root = match opts.symlink_root {
-        Some(ref slr) => &slr[..],
+        Some(slr) => slr,
         None => config.get_symlink_root(),
     };
 
diff --git a/src/commands/gpio_unexportall.rs b/src/commands/gpio_unexportall.rs
@@ -13,7 +13,7 @@ use export;
 
 pub fn main(config: &GpioConfig, opts: &GpioUnexportAllOptions) {
     let symlink_root = match opts.symlink_root {
-        Some(ref slr) => &slr[..],
+        Some(slr) => slr,
         None => config.get_symlink_root(),
     };
 
diff --git a/src/commands/gpio_write.rs b/src/commands/gpio_write.rs
@@ -12,7 +12,7 @@ use std::process::exit;
 use sysfs_gpio::Direction;
 
 pub fn main(config: &GpioConfig, opts: &GpioWriteOptions) {
-    let pin_config = match config.get_pin(&opts.pin[..]) {
+    let pin_config = match config.get_pin(opts.pin) {
         Some(pin) => pin,
         None => {
             println!("Unable to find config entry for pin '{}'", opts.pin);
diff --git a/src/main.rs b/src/main.rs
@@ -154,7 +154,7 @@ fn main() {
         ("read", Some(m)) => {
             let read_options = GpioReadOptions {
                 gpio_opts: gpio_options,
-                pin: String::from(m.value_of("pin").unwrap()),
+                pin: m.value_of("pin").unwrap(),
             };
             gpio_read::main(&cfg, &read_options);
         }
@@ -167,16 +167,16 @@ fn main() {
             });
             let poll_options = GpioPollOptions {
                 gpio_opts: gpio_options,
-                edge: String::from(m.value_of("edge").unwrap_or("both")),
+                edge: m.value_of("edge").unwrap_or("both"),
                 timeout: timeout,
-                pin: String::from(m.value_of("pin").unwrap()),
+                pin: m.value_of("pin").unwrap(),
             };
             gpio_poll::main(&cfg, &poll_options);
         }
         ("write", Some(m)) => {
             let write_options = GpioWriteOptions {
                 gpio_opts: gpio_options,
-                pin: String::from(m.value_of("pin").unwrap()),
+                pin: m.value_of("pin").unwrap(),
                 value: match m.value_of("value").unwrap().parse::<u8>() {
                     Ok(value) => value,
                     Err(_) => {
@@ -191,9 +191,9 @@ fn main() {
         ("export", Some(m)) => {
             let export_options = GpioExportOptions {
                 gpio_opts: gpio_options,
-                pin: String::from(m.value_of("pin").unwrap()),
+                pin: m.value_of("pin").unwrap(),
                 symlink_root: match m.value_of("symlink-root") {
-                    Some(slr) => Some(String::from(slr)),
+                    Some(slr) => Some(slr),
                     None => None,
                 },
             };
@@ -203,7 +203,7 @@ fn main() {
             let exportall_options = GpioExportAllOptions {
                 gpio_opts: gpio_options,
                 symlink_root: match m.value_of("symlink-root") {
-                    Some(slr) => Some(String::from(slr)),
+                    Some(slr) => Some(slr),
                     None => None,
                 },
             };
@@ -212,22 +212,22 @@ fn main() {
         ("unexport", Some(m)) => {
             let unexport_options = GpioUnexportOptions {
                 gpio_opts: gpio_options,
-                pin: String::from(m.value_of("pin").unwrap()),
-                symlink_root: m.value_of("symlink-root").map(String::from),
+                pin: m.value_of("pin").unwrap(),
+                symlink_root: m.value_of("symlink-root"),
             };
             gpio_unexport::main(&cfg, &unexport_options);
         }
         ("unexport-all", Some(m)) => {
             let unexportall_options = GpioUnexportAllOptions {
                 gpio_opts: gpio_options,
-                symlink_root: m.value_of("symlink-root").map(String::from),
+                symlink_root: m.value_of("symlink-root"),
             };
             gpio_unexportall::main(&cfg, &unexportall_options);
         }
         ("status", Some(m)) => {
             let status_options = GpioStatusOptions {
                 gpio_opts: gpio_options,
-                pin: m.value_of("pin").map(String::from),
+                pin: m.value_of("pin"),
             };
             gpio_status::main(&cfg, &status_options);
         }
diff --git a/src/options.rs b/src/options.rs
@@ -12,54 +12,54 @@ pub struct GpioOptions {
 }
 
 #[derive(Debug)]
-pub struct GpioReadOptions {
+pub struct GpioReadOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub pin: String,
+    pub pin: &'a str,
 }
 
 #[derive(Debug)]
-pub struct GpioWriteOptions {
+pub struct GpioWriteOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub pin: String,
+    pub pin: &'a str,
     pub value: u8,
 }
 
 #[derive(Debug)]
-pub struct GpioPollOptions {
+pub struct GpioPollOptions<'a> {
     pub gpio_opts: GpioOptions,
     pub timeout: Option<isize>,
-    pub edge: String,
-    pub pin: String,
+    pub edge: &'a str,
+    pub pin: &'a str,
 }
 
 #[derive(Debug)]
-pub struct GpioExportOptions {
+pub struct GpioExportOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub symlink_root: Option<String>,
-    pub pin: String,
+    pub symlink_root: Option<&'a str>,
+    pub pin: &'a str,
 }
 
 #[derive(Debug)]
-pub struct GpioExportAllOptions {
+pub struct GpioExportAllOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub symlink_root: Option<String>,
+    pub symlink_root: Option<&'a str>,
 }
 
 #[derive(Debug)]
-pub struct GpioUnexportOptions {
+pub struct GpioUnexportOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub symlink_root: Option<String>,
-    pub pin: String,
+    pub symlink_root: Option<&'a str>,
+    pub pin: &'a str,
 }
 
 #[derive(Debug)]
-pub struct GpioUnexportAllOptions {
+pub struct GpioUnexportAllOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub symlink_root: Option<String>,
+    pub symlink_root: Option<&'a str>,
 }
 
 #[derive(Debug)]
-pub struct GpioStatusOptions {
+pub struct GpioStatusOptions<'a> {
     pub gpio_opts: GpioOptions,
-    pub pin: Option<String>,
+    pub pin: Option<&'a str>,
 }
