flag-rs 0.10.0

A Cobra-inspired CLI framework with dynamic completions
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

//! Memory-efficient completion item structure
//!
//! This module provides a more memory-efficient way to store completion items
//! by using a single struct instead of parallel vectors.

use std::borrow::Cow;

/// A single completion item with optional description
#[derive(Clone, Debug)]
pub struct CompletionItem {
    /// The completion value
    pub value: Cow<'static, str>,
    /// Optional description for the completion
    pub description: Option<Cow<'static, str>>,
}

impl CompletionItem {
    /// Creates a new completion item without description
    #[must_use]
    pub fn new(value: impl Into<Cow<'static, str>>) -> Self {
        Self {
            value: value.into(),
            description: None,
        }
    }

    /// Creates a new completion item with description
    #[must_use]
    pub fn with_description(
        value: impl Into<Cow<'static, str>>,
        desc: impl Into<Cow<'static, str>>,
    ) -> Self {
        Self {
            value: value.into(),
            description: Some(desc.into()),
        }
    }

    /// Returns the description or an empty string
    #[must_use]
    pub fn description_or_empty(&self) -> &str {
        self.description.as_deref().unwrap_or("")
    }
}

impl From<&'static str> for CompletionItem {
    fn from(value: &'static str) -> Self {
        Self::new(value)
    }
}

impl From<String> for CompletionItem {
    fn from(value: String) -> Self {
        Self::new(value)
    }
}

impl From<(&'static str, &'static str)> for CompletionItem {
    fn from((value, desc): (&'static str, &'static str)) -> Self {
        Self::with_description(value, desc)
    }
}