helpers4 0.0.6

General-purpose Rust helpers, one crate, one feature per module (string, array, ...)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

// This file is part of helpers4.
// Copyright (C) 2025 baxyz
// SPDX-License-Identifier: LGPL-3.0-or-later

use super::*;

#[test]
fn display_and_debug_hide_the_value() {
    let secret = Secret::new("hunter2".to_string());
    assert_eq!(secret.to_string(), "[REDACTED]");
    assert_eq!(format!("{secret:?}"), "Secret([REDACTED])");
    assert!(!format!("{secret:#?}").contains("hunter2"));
}

#[test]
fn the_value_is_read_explicitly() {
    let secret = Secret::new(String::from("hunter2"));
    assert_eq!(secret.expose(), "hunter2");
    assert_eq!(secret.into_inner(), "hunter2");
}

#[test]
fn it_can_wrap_any_type_and_be_built_with_from() {
    let key: Secret<[u8; 2]> = [1, 2].into();
    assert_eq!(key.expose(), &[1, 2]);
    assert_eq!(Secret::from(7u32).into_inner(), 7);
}

#[test]
fn a_secret_inside_a_struct_stays_hidden_in_its_debug_output() {
    // The fields are only read through the derived `Debug`, which is the point of the test.
    #[allow(dead_code)]
    #[derive(Debug)]
    struct Config {
        user: String,
        password: Secret<String>,
    }
    let config = Config {
        user: "admin".to_string(),
        password: Secret::new("hunter2".to_string()),
    };
    let text = format!("{config:?}");
    assert!(text.contains("admin") && !text.contains("hunter2"));
}

#[test]
fn cloning_keeps_the_value() {
    let secret = Secret::new(String::from("x"));
    assert_eq!(secret.clone().expose(), "x");
}