Skip to content

Implemented macro for compile time non empty string creation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "non-empty-string"
version = "0.2.5"
name = "patskovn-non-empty-string"
version = "0.2.6"
edition = "2021"
authors = ["Midas Lambrichts <midaslamb@gmail.com>"]
authors = ["Midas Lambrichts <midaslamb@gmail.com>", "Nikita Patskov <patskovn@gmail.com>"]
license = "MIT OR Apache-2.0"
description = "A simple type for non empty Strings, similar to NonZeroUsize and friends."
repository = "https://github.com/MidasLamb/non-empty-string"
repository = "https://github.com/patskovn/non-empty-string.git"
keywords = ["nonemptystring", "string", "str", "non-empty", "nonempty"]

[package.metadata."docs.rs"]
Expand All @@ -25,6 +25,7 @@ serde = { version = "1", features = ["derive"] }

[features]
default = []
macro = []
serde = ["dep:serde"]


Expand Down
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ use delegate::delegate;
#[cfg(feature = "serde")]
mod serde_support;

#[cfg(feature = "macro")]
mod macros;

mod trait_impls;

/// A simple String wrapper type, similar to NonZeroUsize and friends.
Expand Down
44 changes: 44 additions & 0 deletions src/macros.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
#[macro_export]
/// Creates a `NonEmptyString` from a string literal at compile time.
///
/// This macro ensures that the provided string is **not empty** at compile time,
/// preventing runtime errors due to empty strings.
///
/// # Examples
///
/// ```
/// use non_empty_string::{non_empty, NonEmptyString};
///
/// let s: NonEmptyString = non_empty!("Hello, Rust!");
/// assert_eq!(s, NonEmptyString::new("Hello, Rust!".to_string()).unwrap());
/// ```
///
/// # Compile-time Failure
///
/// If an empty string is provided, this macro will cause a **compile-time error**.
///
/// ```compile_fail
/// use non_empty_string::non_empty;
///
/// let s = non_empty!("");
/// ```
macro_rules! non_empty {
($s:expr) => {{
// Compile-time assertion to ensure the string is non-empty
const _: () = assert!(!$s.is_empty(), "String cannot be empty");

// Create a NonEmptyString, unsafely wrapping since we've checked it's valid
unsafe { NonEmptyString::new_unchecked($s.to_string()) }
}};
}

#[cfg(test)]
mod tests {
use crate::NonEmptyString;

#[test]
fn test_non_empty_string_macro_valid() {
let s = non_empty!("Test String");
assert_eq!(s, NonEmptyString::try_from("Test String").unwrap());
}
}