Struct SettingMetadata 

pub struct SettingMetadata {

    pub setting_type: SettingType,
    pub default: Value,
    pub value: Option<Value>,
    pub label: String,
    pub description: Option<String>,
    pub options: Option<Vec<SettingOption>>,
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub step: Option<f64>,
    pub placeholder: Option<String>,
    pub category: Option<String>,
    pub order: Option<i32>,
    pub secret_storage: Option<SecretStorage>,
    pub pattern: Option<String>,
    pub pattern_error: Option<String>,
    pub flags: SettingFlags,
}

Fields

setting_type: SettingType

Type of setting (for UI rendering)

default: Value

Default value

value: Option<Value>

Current value (populated at runtime)

label: String

Human-readable label

description: Option<String>

Description/help text

options: Option<Vec<SettingOption>>

Available options (for Select type)

min: Option<f64>

Minimum value (for Number type)

max: Option<f64>

Maximum value (for Number type)

step: Option<f64>

Step increment (for Number type)

placeholder: Option<String>

Placeholder text

category: Option<String>

Category for grouping in UI

order: Option<i32>

Order within category (lower = higher priority)

secret_storage: Option<SecretStorage>

Where to store secret values (only used if secret=true)

pattern: Option<String>

Regex pattern for validation (for Text type)

pattern_error: Option<String>

Error message for pattern validation failure

flags: SettingFlags

Implementations

impl SettingMetadata

pub fn text(label: impl Into<String>, default: impl Into<String>) -> Self

Create a text input setting

pub fn password(label: impl Into<String>, default: impl Into<String>) -> Self

Create a password/secret input setting

pub fn number(label: impl Into<String>, default: impl Into<f64>) -> Self

Create a number input setting

pub fn toggle(label: impl Into<String>, default: bool) -> Self

Create a toggle/boolean setting

pub fn select( label: impl Into<String>, default: impl Into<String>, options: Vec<SettingOption>, ) -> Self

Create a select/dropdown setting

pub fn color(label: impl Into<String>, default: impl Into<String>) -> Self

Create a color picker setting

pub fn path(label: impl Into<String>, default: impl Into<String>) -> Self

Create a directory path selector setting

pub fn file(label: impl Into<String>, default: impl Into<String>) -> Self

Create a file path selector setting

pub fn info(label: impl Into<String>, default: Value) -> Self

Create an info/read-only setting

pub fn list(label: impl Into<String>, default: &[String]) -> Self

Create a list setting (Vec<String>)

pub fn description(self, desc: impl Into<String>) -> Self

Set description

pub fn options(self, opts: Vec<SettingOption>) -> Self

Set options for Select type

pub fn min(self, val: f64) -> Self

Set minimum value for Number type

pub fn max(self, val: f64) -> Self

Set maximum value for Number type

pub fn step(self, val: f64) -> Self

Set step for Number type

pub fn placeholder(self, text: impl Into<String>) -> Self

Set placeholder text

pub fn requires_restart(self) -> Self

Mark setting as requiring restart

pub fn category(self, cat: impl Into<String>) -> Self

Set category for grouping

pub fn order(self, ord: i32) -> Self

Set display order

pub fn advanced(self) -> Self

Mark setting as advanced

pub fn disabled(self) -> Self

Mark setting as disabled

pub fn secret(self) -> Self

⚠️ IMPORTANT: This method requires enabling one of the following features:

• keychain - Store secrets in OS keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service)
• encrypted-file - Store secrets in an encrypted file using Argon2id

Without these features, secrets will be stored in plaintext JSON, which is a security risk!

Feature Setup

Add to your Cargo.toml:

[dependencies]
rcman = { version = "0.2", features = ["keychain"] }
# Or for encrypted file storage:
rcman = { version = "0.2", features = ["encrypted-file"] }

Compile-Time Safety

If you call .secret() without enabling the required features, you’ll get a compile error with instructions on how to fix it. This prevents accidentally storing secrets in plaintext.

Example

use rcman::{settings, SettingMetadata};
use std::collections::HashMap;

settings! {
    "api.key" => SettingMetadata::password("API Key", "")
        .secret(),  // ✅ Safe: stored in keychain or encrypted file
}

pub fn pattern(self, pattern: impl Into<String>) -> Self

Set regex pattern for validation

pub fn pattern_error(self, msg: impl Into<String>) -> Self

Set pattern validation error message

pub fn validate(&self, value: &Value) -> Result<(), String>

Validate a value against this setting’s constraints

Checks:

• Number range (min/max)
• Regex pattern for text
• Valid option for select type

Arguments

• value - The value to validate

Returns

Returns Ok(()) if validation passes, or Err(String) if validation fails.

Errors

Returns an error string if validation fails.

Trait Implementations

impl Clone for SettingMetadata

fn clone(&self) -> SettingMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SettingMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SettingMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SettingMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SettingMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.