From bcf144435e6e12f7971ae511dde804253a28fdb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Raphael=20H=C3=B6ser?= Date: Tue, 6 May 2025 16:08:34 +0200 Subject: [PATCH 1/3] chore: Replace boilerplate lib.rs with a basic setup of compiler configs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Raphael Höser --- README.md | 16 +++++++++++++++- src/lib.rs | 31 ++++++++++++++++++------------- 2 files changed, 33 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 446cdfc..6c3db0c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # eventsourcingdb-client-rust -The official Rust client SDK for EventSourcingDB. + +The official Rust client SDK for [EventSourcingDB](https://www.eventsourcingdb.io/). + +# Project status + +This is a work in progress and not yet ready for production use. +Based on the [compliance criteria](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/) the SDK covers these criteria: + +- ❌ Essentials +- ❌ Writing Events +- ❌ Reading Events +- ❌ Using EventQL +- ❌ Observing Events +- ❌ Metadata and Discovery +- ❌ Testcontainers Support diff --git a/src/lib.rs b/src/lib.rs index b93cf3f..d499a98 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,14 +1,19 @@ -pub fn add(left: u64, right: u64) -> u64 { - left + right -} +#![doc = include_str!("../README.md")] -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn it_works() { - let result = add(2, 2); - assert_eq!(result, 4); - } -} +#![warn( + ambiguous_negative_literals, + bad_style, + clippy::pedantic, + missing_debug_implementations, + missing_docs, + non_shorthand_field_patterns, + overflowing_literals, + path_statements, + trivial_casts, + trivial_numeric_casts, + unused_extern_crates, + unused_import_braces, + unused_qualifications, + unused_results +)] +#![deny(unsafe_code)] From a4129f0b5be5bb8d7f42d1d01bb8021476da54e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Raphael=20H=C3=B6ser?= Date: Wed, 7 May 2025 10:09:08 +0200 Subject: [PATCH 2/3] chore: update warnings to use deny instead --- src/lib.rs | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index d499a98..5337c09 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,19 +1,16 @@ #![doc = include_str!("../README.md")] -#![warn( +#![deny( ambiguous_negative_literals, - bad_style, clippy::pedantic, missing_debug_implementations, missing_docs, - non_shorthand_field_patterns, - overflowing_literals, - path_statements, trivial_casts, trivial_numeric_casts, unused_extern_crates, unused_import_braces, unused_qualifications, - unused_results + unused_results, + unsafe_code, + warnings )] -#![deny(unsafe_code)] From 12d6ca2225ad2eea3db5957d01d2ee170cfe7334 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Raphael=20H=C3=B6ser?= Date: Wed, 7 May 2025 10:23:11 +0200 Subject: [PATCH 3/3] chore: link to compliance criteria from README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6c3db0c..d9613a9 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ The official Rust client SDK for [EventSourcingDB](https://www.eventsourcingdb.i This is a work in progress and not yet ready for production use. Based on the [compliance criteria](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/) the SDK covers these criteria: -- ❌ Essentials -- ❌ Writing Events -- ❌ Reading Events -- ❌ Using EventQL -- ❌ Observing Events -- ❌ Metadata and Discovery -- ❌ Testcontainers Support +- ❌ [Essentials](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#essentials) +- ❌ [Writing Events](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#writing-events) +- ❌ [Reading Events](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#reading-events) +- ❌ [Using EventQL](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#using-eventql) +- ❌ [Observing Events](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#observing-events) +- ❌ [Metadata and Discovery](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#metadata-and-discovery) +- ❌ [Testcontainers Support](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#testcontainers-support)