tokenless-core 1.0.0

Shared core types for tokenless
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

/// Validated configuration for tokenless components.
///
/// The `name` field must be non-empty.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Config {
    name: String,
    description: Option<String>,
}

impl Config {
    /// Create a new `Config` with a non-empty name.
    ///
    /// # Errors
    ///
    /// Returns [`crate::CoreError::App`] if `name` is empty or whitespace-only.
    pub fn new(name: impl Into<String>) -> crate::Result<Self> {
        let name = name.into();
        if name.trim().is_empty() {
            return Err(crate::CoreError::App(
                "config name must not be empty".into(),
            ));
        }
        Ok(Self {
            name,
            description: None,
        })
    }

    /// Set an optional description.
    #[must_use]
    pub fn with_description(mut self, desc: impl Into<String>) -> Self {
        self.description = Some(desc.into());
        self
    }

    /// Return the configuration name.
    #[must_use]
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Return the optional description.
    #[must_use]
    pub fn description(&self) -> Option<&str> {
        self.description.as_deref()
    }
}