diff libpam-sys/libpam-sys-consts/src/lib.rs @ 148:4b3a5095f68c

Move libpam-sys helpers into their own library. - Renames libpam-sys-helpers to libpam-sys-consts. - Moves libpam-sys-helpers::helpers into libpam-sys-helpers, which moves them completely out of libpam-sys's dependency chain. - Moves the aliases from libpam-sys into libpam-sys::aliases.
author Paul Fisher <paul@pfish.zone>
date Mon, 07 Jul 2025 12:11:43 -0400
parents libpam-sys/libpam-sys-helpers/src/memory.rs@ebb71a412b58
children ab8020566cd9
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpam-sys/libpam-sys-consts/src/lib.rs	Mon Jul 07 12:11:43 2025 -0400
@@ -0,0 +1,44 @@
+pub mod constants;
+
+/// Information about the PAM implementation you're using right now.
+///
+/// This module contains constants and values that can be used at build-script,
+/// compile, and run time to determine what PAM implementation you're using.
+///
+/// ## Always available
+///
+/// [`PamImpl::CURRENT`] will tell you what version of PAM you're using.
+/// It can be imported in any Rust code, from build scripts to runtime.
+///
+/// ## Compile time
+///
+/// Use [`enable_pam_impl_cfg`] in your `build.rs` to generate custom `#[cfg]`s
+/// for conditional compilation based on PAM implementation.
+///
+/// This will set the current `pam_impl` as well as registering all known
+/// PAM implementations with `rustc-check-cfg` to get cfg-checking.
+///
+/// The names that appear in the `cfg` variables are the same as the values
+/// in the [`PamImpl`] enum.
+///
+/// ```
+/// #[cfg(pam_impl = "OpenPam")]
+/// fn openpam_specific_func(handle: *const libpam_sys::pam_handle) {
+///     let environ = libpam_sys::pam_getenvlist(handle);
+///     // ...
+///     libpam_sys::openpam_free_envlist()
+/// }
+///
+/// // This will give you a warning since "UnknownImpl" is not in the cfg.
+/// #[cfg(not(pam_impl = "UnknownImpl"))]
+/// fn do_something() {
+///     // ...
+/// }
+/// ```
+///
+/// The [`pam_impl_name!`] macro will expand to this same value, currently
+#[doc = concat!("`", env!("LIBPAMSYS_IMPL"), "`.")]
+pub mod pam_impl;
+
+#[doc(inline)]
+pub use pam_impl::*;