refactor(cfg): improve conditional compilation

Add the required features for each example.

Signed-off-by: Joshua Chapman <joshua.chapman@secomind.com>

Author: joshuachp

Cargo.toml

@@ -164,3 +164,13 @@ webpki-roots = "0.26.0"
 # Transitive dependencies
 litemap = "=0.7.4"
 zerofrom = "=0.1.5"
+
+[[example]]
+name = "msghub_client"
+path = "examples/message_hub_client/main.rs"
+required-features = ["message-hub", "derive"]
+
+[[example]]
+name = "object_datastream"
+path = "examples/object_datastream/main.rs"
+required-features = ["derive"]

docs/connect-to-the-astarte-message-hub.md

@@ -15,7 +15,7 @@ The Astarte Device SDK supports two different connection types:
 Here we will go through, step by step, on how to connect and send data to the Message Hub.
 
 > You can find the full code by going to the
-> [msghub-client example](https://github.com/astarte-platform/astarte-device-sdk-rust/tree/master/examples/msghub-client)
+> [message hub client example](https://github.com/astarte-platform/astarte-device-sdk-rust/tree/master/examples/message_hub_client)
 
 ## Before you begin
 
@@ -37,9 +37,9 @@ Hub server, and all the keys necessary to register the Message Hub server as a n
 ### Message Hub Server
 
 To register the server you can follow the guide and examples in
-[the MessageHub repository](https://github.com/astarte-platform/astarte-message-hub). Following
-this, we assume the Server is listening on the same machine IP v4 address `127.0.0.1` and port
-`50051`.
+[the Astarte MessageHub repository](https://github.com/astarte-platform/astarte-message-hub).
+Following this, we assume the Server is listening on the same machine IP v4 address `127.0.0.1` and
+port `50051`.
 
 #### Client Auth
 
@@ -286,8 +286,8 @@ function that we declared previously.
 # const NODE_UUID: uuid::Uuid = uuid::uuid!("0444d8c3-f3f1-4b89-9e68-6ffb50ec1839");
 # const MESSAGE_HUB_URL: &str = "http://127.0.0.1:50051";
 # const STORE_DIRECTORY: &str = "./store-dir";
-
-// NOTO: set the interface directory in your project, these are relative to this file
+#
+// NOTE: set the interface directory in your project, these are relative to this file
 const AGGREGATED_DEVICE: &str = include_str!("../../docs/interfaces/org.astarte-platform.rust.get-started.Aggregated.json");
 const INDIVIDUAL_DEVICE: &str = include_str!("../../docs/interfaces/org.astarte-platform.rust.get-started.IndividualDevice.json");
 const INDIVIDUAL_SERVER: &str = include_str!("../../docs/interfaces/org.astarte-platform.rust.get-started.IndividualServer.json");
@@ -334,8 +334,6 @@ We can now spawn a task to receive data from Astarte. Using the
 #     transport::grpc::{tonic::transport::Endpoint, Grpc, GrpcConfig},
 #     DeviceClient, DeviceConnection,
 # };
-
-
 # #[cfg(not(feature = "derive"))]
 # use astarte_device_sdk_derive::FromEvent;
 # #[cfg(feature = "derive")]
@@ -395,8 +393,6 @@ async fn receive_data(client: DeviceClient<SqliteStore>) -> eyre::Result<()> {
     }
 }
 
-
-
 #[tokio::main]
 async fn main() -> eyre::Result<()> {
 # let mut tasks = tokio::task::JoinSet::new();
@@ -446,7 +442,7 @@ convert the Rust struct in an Object Aggregate to send.
 #     transport::grpc::{tonic::transport::Endpoint, Grpc, GrpcConfig},
 #     DeviceClient, DeviceConnection,
 # };
-
+#
 use std::time::Duration;
 
 # #[cfg(feature = "derive")]

examples/msghub-client/README.md examples/message_hub_client/README.mdexamples/msghub-client/README.md renamed to examples/message_hub_client/README.md

@@ -18,9 +18,6 @@
 
 //! Example on connecting to the Astarte MessageHub.
 
-// Features required by the example
-#![cfg(all(feature = "message-hub", feature = "derive"))]
-
 use std::{f64, time::Duration};
 
 use astarte_device_sdk::{

examples/msghub-client/main.rs examples/message_hub_client/main.rsexamples/msghub-client/main.rs renamed to examples/message_hub_client/main.rs

@@ -22,13 +22,10 @@ use std::time::Duration;
 
 use serde::{Deserialize, Serialize};
 
-#[cfg(feature = "derive")]
 use astarte_device_sdk::AstarteAggregate;
 use astarte_device_sdk::{
     builder::DeviceBuilder, prelude::*, store::memory::MemoryStore, transport::mqtt::MqttConfig,
 };
-#[cfg(not(feature = "derive"))]
-use astarte_device_sdk_derive::AstarteAggregate;
 use tokio::task::JoinSet;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
 

examples/object_datastream/main.rs

@@ -197,9 +197,11 @@ impl ReadConnection {
     pub(crate) fn connect(db_file: impl AsRef<Path>) -> Result<Self, SqliteError> {
         let flags = OpenFlags::SQLITE_OPEN_READ_ONLY | OpenFlags::SQLITE_OPEN_NO_MUTEX;
 
-        let mut connection =
+        let connection =
             Connection::open_with_flags(db_file, flags).map_err(SqliteError::Connection)?;
 
+        #[cfg(feature = "sqlite-trace")]
+        let mut connection = connection;
         #[cfg(feature = "sqlite-trace")]
         connection.trace(Some(trace_sqlite));