zrx-id 0.0.12

Identifier abstractions and utilities
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

// Copyright (c) 2025-2026 Zensical and contributors

// SPDX-License-Identifier: MIT
// All contributions are certified under the DCO

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the `Software`), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED `AS IS`, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

// ----------------------------------------------------------------------------

//! Atom.

use std::fmt::{self, Display, Write};

use super::segments::Segments;

mod character;
mod wildcard;

pub use character::Character;
pub use wildcard::Wildcard;

// ----------------------------------------------------------------------------
// Enums
// ----------------------------------------------------------------------------

/// Atom.
///
/// Atoms are the basic building blocks of [`Segments`], representing literals,
/// wildcards, character classes and groups of alternatives. Each [`Segment`][]
/// contains a set of atoms that define which [`Specificity`][] the segment has,
/// where specificity is determined by the least specific atom in the segment.
///
/// [`Segment`]: crate::id::specificity::segment::Segment
/// [`Specificity`]: crate::id::specificity::Specificity
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Atom<'a> {
    /// Literal, e.g., `main.rs`
    Literal(&'a str),
    /// Wildcard, i.e., `?`, `*`, or `**`.
    Wildcard(Wildcard),
    /// Character class, e.g., `[xyz]`.
    Character(Character<'a>),
    /// Alternate group, e.g., `{*.rs,*.md}`.
    Group(Vec<Segments<'a>>),
}

// ----------------------------------------------------------------------------
// Trait implementations
// ----------------------------------------------------------------------------

impl Display for Atom<'_> {
    /// Formats the atom for display.
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Atom::Literal(literal) => Display::fmt(literal, f),
            Atom::Wildcard(wildcard) => Display::fmt(wildcard, f),
            Atom::Character(character) => Display::fmt(character, f),
            Atom::Group(group) => {
                f.write_char('{')?;
                for (i, segments) in group.iter().enumerate() {
                    Display::fmt(&segments, f)?;

                    // Write comma if not last
                    if i < group.len() - 1 {
                        f.write_char(',')?;
                    }
                }
                f.write_char('}')
            }
        }
    }
}