feat: set initial text at spinner creation

README.md

@@ -28,7 +28,7 @@ Basic example.
 use spinach::Spinner;
 
 fn main() {
-    let s = Spinner::new().text("Cutting spinaches...").start();
+    let s = Spinner::new("Cutting spinaches...").start();
     // Cut spinaches
     s.text("Cutting tomatoes...").update();
     // Cut tomatoes
@@ -42,12 +42,11 @@ fn main() {
 use spinach::{Color, Spinner};
 
 // With custom text
-let s = Spinner::new().text("workin'...").start();
+let s = Spinner::new("workin'...").start();
 
 // With custom text, spinner, spinner speed and spinner color
 let symbols = vec!["▮","▯"];
-let s = Spinner::new()
-    .text("blip... blop...")
+let s = Spinner::new("blip... blop...")
     .color(Color::Red)
     .symbols(symbols)
     .frames_duration(80)
@@ -59,7 +58,7 @@ let s = Spinner::new()
 ```rust
 use spinach::{Color, Spinner};
 
-let s = Spinner::new().text("workin'...").start();
+let s = Spinner::new("workin'...").start();
 
 // Updating text
 s.text("new text").update();
@@ -82,18 +81,18 @@ s.text("new text").color(Color::Red);
 ```rust
 use spinach::{Color, Spinner};
 
-let s = Spinner::new().text("workin'...").start();
+let s = Spinner::new("workin'...").start();
 
-// Stop with final `✔` frame, green color and optional text change.
+// Stop with final `✔` frame and green color.
 s.text("gg!").success();
 
-// Stop with final `✖` frame, red color and optional text change.
+// Stop with final `✖` frame and red color.
 s.text("ups").failure();
 
-// Stop with final `⚠` frame, yellow color and optional text change.
+// Stop with final `⚠` frame and yellow color.
 s.text("something may have happened?").warn();
 
-// Stop with final `ℹ` frame, blue color and optional text change.
+// Stop with final `ℹ` frame and blue color.
 s.text("notice").stop();
 
 // Stop current spinner (sends update at the same time)
@@ -119,7 +118,7 @@ fn main() {
     })
     .expect("Error setting Ctrl-C handler");
 
-    let s = Spinner::new().text("workin'...").start();
+    let s = Spinner::new("workin'...").start();
     // ...
 ```
 

examples/cooking.rs

@@ -5,19 +5,17 @@ use spinach::Color::Green;
 use spinach::Spinner;
 
 fn main() {
-    let spinner = Spinner::new()
+    let spinner = Spinner::new("Cutting spinaches")
         .color(Green)
-        .text("Cutting spinaches")
         .frames_duration(30)
         .start();
     sleep(Duration::from_secs(1));
     spinner.text("Cutting tomatoes").update();
     sleep(Duration::from_secs(1));
     spinner.text("Vegetables cut").symbols(vec!["🔪"]).stop();
 
-    let spinner = Spinner::new()
+    let spinner = Spinner::new("Cooking vegetables")
         .color(Green)
-        .text("Cooking vegetables")
         .frames_duration(30)
         .start();
     sleep(Duration::from_secs(1));

src/spinner.rs

@@ -15,7 +15,7 @@ use crate::term;
 /// ```
 /// use spinach::Spinner;
 ///
-/// let spinner = Spinner::new().text("Loading...").start();
+/// let spinner = Spinner::new("Loading...").start();
 /// // Perform some tasks
 /// spinner.text("gg!").success();
 /// ```
@@ -44,7 +44,7 @@ impl<S> Spinner<S> {
     /// ```
     /// use spinach::{Spinner, Color};
     ///
-    /// let spinner = Spinner::new().color(Color::Blue).start();
+    /// let spinner = Spinner::new("workin'...").color(Color::Blue).start();
     /// ```
     pub fn color(&self, color: term::Color) -> &Self {
         self.update.borrow_mut().color = Some(color);
@@ -58,7 +58,7 @@ impl<S> Spinner<S> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("workin'...").start();
+    /// let spinner = Spinner::new("workin'...").start();
     /// ```
     pub fn text(&self, text: &str) -> &Self {
         self.update.borrow_mut().text = Some(text.to_string());
@@ -72,7 +72,7 @@ impl<S> Spinner<S> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().symbols(vec!["◐", "◓", "◑", "◒"]).start();
+    /// let spinner = Spinner::new("workin'...").symbols(vec!["◐", "◓", "◑", "◒"]).start();
     /// ```
     pub fn symbols(&self, symbols: Vec<&'static str>) -> &Self {
         self.update.borrow_mut().symbols = Some(symbols);
@@ -86,7 +86,7 @@ impl<S> Spinner<S> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().frames_duration(40).start();
+    /// let spinner = Spinner::new("workin'...").frames_duration(40).start();
     /// ```
     pub fn frames_duration(&self, ms: u64) -> &Self {
         self.update.borrow_mut().frames_duration_ms = Some(ms);
@@ -102,12 +102,12 @@ impl Spinner<Stopped> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("let's go...").start();
+    /// let spinner = Spinner::new("let's go...").start();
     /// ```
     #[must_use]
-    pub fn new() -> Self {
+    pub fn new(text: &str) -> Self {
         Spinner {
-            update: RefCell::new(Update::default()),
+            update: RefCell::new(Update::new(text)),
             state: Stopped,
         }
     }
@@ -119,7 +119,7 @@ impl Spinner<Stopped> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("let's go...").start();
+    /// let spinner = Spinner::new("let's go...").start();
     /// ```
     pub fn start(&self) -> Spinner<Running> {
         term::hide_cursor();
@@ -175,7 +175,7 @@ impl Spinner<Running> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("Doing something...").start();
+    /// let spinner = Spinner::new("Doing something...").start();
     /// // Perform some tasks
     /// spinner.text("Doing something else...").update();
     /// ```
@@ -191,7 +191,7 @@ impl Spinner<Running> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("Doing something...").start();
+    /// let spinner = Spinner::new("Doing something...").start();
     /// // Perform some tasks
     /// spinner.text("done!").stop();
     /// ```
@@ -209,7 +209,7 @@ impl Spinner<Running> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("Doing something...").start();
+    /// let spinner = Spinner::new("Doing something...").start();
     /// // Perform some task that succeeds
     /// spinner.text("done!").success();
     /// ```
@@ -227,7 +227,7 @@ impl Spinner<Running> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("Doing something...").start();
+    /// let spinner = Spinner::new("Doing something...").start();
     /// // Perform some task that fails
     /// spinner.text("oops").failure();
     /// ```
@@ -245,7 +245,7 @@ impl Spinner<Running> {
     /// ```
     /// use spinach::Spinner;
     ///
-    /// let spinner = Spinner::new().text("Doing something...").start();
+    /// let spinner = Spinner::new("Doing something...").start();
     /// // Perform some task with unexpected results
     /// spinner.text("wait, what?").warn();
     /// ```

src/state.rs

@@ -67,3 +67,12 @@ pub struct Update {
     /// Optional new frame duration in milliseconds.
     pub frames_duration_ms: Option<u64>,
 }
+
+impl Update {
+    pub fn new(text: &str) -> Self {
+        Self {
+            text: Some(text.to_owned()),
+            ..Self::default()
+        }
+    }
+}