Add stringify_segment rustdoc

benches/benchmarks.rs

@@ -4,9 +4,9 @@ extern crate test;
 
 #[cfg(test)]
 mod tests {
+    use clap::{App, Arg};
     use starship::{modules, print};
     use test::Bencher;
-    use clap::{App, Arg};
 
     #[bench]
     fn full_prompt_bench(b: &mut Bencher) {

src/modules/directory.rs

@@ -1,8 +1,8 @@
 use super::Segment;
-use dirs;
-use std::env;
 use ansi_term::{Color, Style};
 use clap::ArgMatches;
+use dirs;
+use std::env;
 
 /// Creates a segment with the current directory
 pub fn segment(_: &ArgMatches) -> Segment {

src/modules/mod.rs

@@ -1,9 +1,9 @@
-mod char;
+mod character;
 mod directory;
 mod line_break;
 
-use clap::ArgMatches;
 use ansi_term::Style;
+use clap::ArgMatches;
 
 pub struct Segment {
     pub style: Style,
@@ -18,21 +18,21 @@ impl Default for Segment {
             style: Style::default(),
             value: String::from(" "),
             prefix: None,
-            suffix: None
+            suffix: None,
         }));
 
         Segment {
             style: Style::default(),
             value: String::from(""),
             prefix: None,
-            suffix: default_suffix
+            suffix: default_suffix,
         }
     }
 }
 
 pub fn handle(module: &str, args: &ArgMatches) -> Segment {
     match module {
-        "char" | "character" => char::segment(&args),
+        "char" | "character" => character::segment(&args),
         "dir" | "directory" => directory::segment(&args),
         "line_break" => line_break::segment(&args),
 

src/print.rs

@@ -5,12 +5,30 @@ use clap::ArgMatches;
 pub fn prompt(args: ArgMatches) {
     let default_prompt = vec!["directory", "line_break", "character"];
 
-    default_prompt.into_iter()
+    default_prompt
+        .into_iter()
         .map(|module| modules::handle(module, &args))
         .map(|segment| stringify_segment(segment))
         .for_each(|segment_string| print!("{}", segment_string));
 }
 
+/// Create a string with the formatted contents of a segment
+///
+/// Will recursively also format the prefix and suffix of the segment being
+/// stringified.
+///
+/// # Example
+/// ```
+/// use starship::modules::Segment;
+///
+/// let segment = Segment {
+///     value: String::from("->"),
+///     ..Default::default()
+/// };
+///
+/// let result = starship::print::stringify_segment(segment);
+/// assert_eq!(result, "-> ");
+/// ```
 pub fn stringify_segment(segment: Segment) -> String {
     let Segment {
         prefix,