Skip to main content

dynamic_alias

secure_gate

Macro dynamic_alias 

Source 
macro_rules! dynamic_alias {
    ($vis:vis $name:ident, $inner:ty, $doc:literal) => { ... };
    ($vis:vis $name:ident, $inner:ty) => { ... };
    ($name:ident, $inner:ty, $doc:literal) => { ... };
    ($name:ident, $inner:ty) => { ... };
}
Expand description

Creates a type alias for Dynamic<T>.

Generates a named, optionally-documented type alias. The generated type inherits all Dynamic<T> methods including expose_secret(), with_secret(), to_hex(), etc.

Requires feature alloc.

§Syntax

dynamic_alias!(pub Name, T);                // public, auto-generated doc
dynamic_alias!(pub(crate) Name, T);         // crate-visible
dynamic_alias!(Name, T);                    // private
dynamic_alias!(pub Name, T, "doc string");  // with custom doc

§Examples

All three visibility forms:

use secure_gate::{dynamic_alias, RevealSecret};

dynamic_alias!(pub Password, String);            // public
dynamic_alias!(pub(crate) SessionToken, Vec<u8>); // crate-visible
dynamic_alias!(private_key_bytes, Vec<u8>);      // private

let pw: Password = "hunter2".into();
pw.with_secret(|s| assert!(!s.is_empty()));

With a custom doc string:

use secure_gate::{dynamic_alias, RevealSecret};

dynamic_alias!(pub Token, Vec<u8>, "OAuth 2.0 bearer token.");
let token: Token = vec![1u8, 2, 3].into();
assert_eq!(token.expose_secret(), &[1, 2, 3]);

§Implementation Notes

dynamic_alias! has no zero-size or type-level guard — any T is accepted. Macro-generated aliases lack runtime size checks beyond what Dynamic<T> itself provides. Note that unlike fixed_alias!, this macro (and the generic dynamic variant) allows zero-sized or empty inner types with no compile-time rejection. Validate expected inner types and sizes in unit tests:

use secure_gate::dynamic_alias;

dynamic_alias!(pub ApiToken, Vec<u8>);
// In your tests: assert!(token.len() > 0);

§Security

Generated aliases inherit all Dynamic security guarantees: zeroize on drop (including spare capacity), redacted Debug, explicit access only.

§See also