Struct PathDomain 

pub struct PathDomain;

A domain for file path-like keys

This domain allows forward slashes and is suitable for hierarchical keys that resemble file paths:

• Allows alphanumeric, underscore, hyphen, dot, and forward slash
• Case-insensitive
• No consecutive slashes
• Cannot start or end with slash

Examples

use domain_key::{Key, PathDomain};

type PathKey = Key<PathDomain>;

let key = PathKey::new("users/profile/settings")?;
assert_eq!(key.as_str(), "users/profile/settings");

Trait Implementations

impl Debug for PathDomain

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

Formats the value using the given formatter.

impl Domain for PathDomain

const DOMAIN_NAME: &'static str = "path"

Human-readable name for this domain

impl KeyDomain for PathDomain

const MAX_LENGTH: usize = 256

Maximum length for keys in this domain

const EXPECTED_LENGTH: usize = 48

Optimization hint: expected average key length for this domain

const TYPICALLY_SHORT: bool = false

Optimization hint: whether keys in this domain are typically short (≤32 chars)

const CASE_INSENSITIVE: bool = true

Whether keys in this domain are case-insensitive

const FREQUENTLY_SPLIT: bool = true

Optimization hint: whether keys in this domain are frequently split

const HAS_CUSTOM_VALIDATION: bool = true

Whether this domain has custom validation rules

fn allowed_characters(c: char) -> bool

Check which characters are allowed for this domain

fn allowed_start_character(c: char) -> bool

Check if a character is allowed at the start of a key

fn allowed_end_character(c: char) -> bool

Check if a character is allowed at the end of a key

fn allowed_consecutive_characters(prev: char, curr: char) -> bool

Check if two consecutive characters are allowed

fn default_separator() -> char

Get the default separator character for this domain

fn validate_domain_rules(key: &str) -> Result<(), KeyParseError>

Domain-specific validation rules

fn validation_help() -> Option<&'static str>

Get domain-specific help text for validation errors

fn examples() -> &'static [&'static str]

Get examples of valid keys for this domain

const HAS_CUSTOM_NORMALIZATION: bool = false

Whether this domain has custom normalization rules

const FREQUENTLY_COMPARED: bool = false

Optimization hint: whether keys in this domain are frequently compared

fn normalize_domain(key: Cow<'_, str>) -> Cow<'_, str>

Domain-specific normalization

fn is_reserved_prefix(_key: &str) -> bool

Check if a key has a reserved prefix for this domain

fn is_reserved_suffix(_key: &str) -> bool

Check if a key has a reserved suffix for this domain

fn requires_ascii_only(_key: &str) -> bool

Check if the key contains only ASCII characters

fn min_length() -> usize

Get the minimum allowed length for keys in this domain