feat: add examples

crates/komorebi-util/examples/async.rs

@@ -0,0 +1,12 @@
+use komorebi_util::{Client, KomorebiOutput};
+
+#[tokio::main]
+async fn main() -> komorebi_util::Result<()> {
+  let client = Client::new()?;
+
+  while let Some(output) = client.output().await {
+    println!("Output: {:?}", output);
+  }
+
+  Ok(())
+}

crates/komorebi-util/examples/sync.rs

@@ -0,0 +1,11 @@
+use komorebi_util::{Client, KomorebiOutput};
+
+fn main() -> komorebi_util::Result<()> {
+  let client = Client::new()?;
+
+  while let Some(output) = client.output_blocking() {
+    println!("Output: {:?}", output);
+  }
+
+  Ok(())
+}

crates/komorebi-util/src/client.rs

@@ -42,8 +42,8 @@ impl KomorebiClient {
   }
 
   /// Returns the latest state from Komorebi.
-  pub async fn output_blocking(&self) -> crate::Result<KomorebiOutput> {
-    self.output_rx.recv().map_err(Error::StreamRead)
+  pub fn output_blocking(&self) -> crate::Result<KomorebiOutput> {
+    self.output_rx.blocking_recv().map_err(Error::StreamRead)
   }
 
   /// Listens for socket messages on a separate thread.
@@ -87,7 +87,7 @@ impl KomorebiClient {
               .map_err(Error::InvalidUtf8)
               .and_then(|str| {
                 serde_json::from_str::<Notification>(&str)
-                  .map_err(Error::NotificationParse)
+                  .map_err(Error::OutputParse)
               })
               .map(|notification| notification.state.into());
 

crates/komorebi-util/src/error.rs

@@ -5,16 +5,16 @@ pub enum Error {
   #[error("Failed to initialize socket: {0}")]
   SocketInitialization(#[from] std::io::Error),
 
-  #[error("Failed to parse notification: {0}")]
-  NotificationParse(#[from] serde_json::Error),
+  #[error("Failed to parse output: {0}")]
+  OutputParse(#[from] serde_json::Error),
 
   #[error("Failed to read stream.")]
   StreamRead,
 
   #[error("Invalid UTF-8 in buffer: {0}")]
   InvalidUtf8(#[from] std::string::FromUtf8Error),
 
-  #[error("Komorebi client already stopped.")]
+  #[error("Komorebi client has already been stopped.")]
   AlreadyStopped,
 }