Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2025-01-18 23:53:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #5645 from epage/complete

Browse source 
docs(complete): Clarify CompletionCandidate
This commit is contained in:
Ed Page 2024-08-09 15:36:39 -05:00 committed by GitHub
commit 7916e79a58
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
clap_complete/src/dynamic/candidate.rs
View file

@ -3,19 +3,14 @@ use std::ffi::OsString;
use clap::builder::StyledStr;
/// A completion candidate definition
/// A shell-agnostic completion candidate
///
/// This makes it easier to add more fields to completion candidate,
/// rather than using `(OsString, Option<StyledStr>)` or `(String, Option<StyledStr>)` to represent a completion candidate
/// [`ShellCompleter`][crate::dynamic::shells::ShellCompleter] will adapt what it can to the
/// current shell.
#[derive(Default, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct CompletionCandidate {
/// Main completion candidate content
content: OsString,
/// Help message with a completion candidate
help: Option<StyledStr>,
/// Whether the completion candidate is hidden
hidden: bool,
}
@ -36,11 +31,28 @@ impl CompletionCandidate {
}
/// Set the visibility of the completion candidate
///
/// Only shown when no there is no visible candidate for completing the current argument.
pub fn hide(mut self, hidden: bool) -> Self {
self.hidden = hidden;
self
}
/// Add a prefix to the content of completion candidate
///
/// This is generally used for post-process by [`complete`][crate::dynamic::complete()] for
/// things like pre-pending flags, merging delimiter-separated values, etc.
pub fn add_prefix(mut self, prefix: impl Into<OsString>) -> Self {
let suffix = self.content;
let mut content = prefix.into();
content.push(&suffix);
self.content = content;
self
}
}
/// Reflection API
impl CompletionCandidate {
/// Get the content of the completion candidate
pub fn get_content(&self) -> &OsStr {
&self.content
@ -55,13 +67,4 @@ impl CompletionCandidate {
pub fn is_hide_set(&self) -> bool {
self.hidden
}
/// Add a prefix to the content of completion candidate
pub fn add_prefix(mut self, prefix: impl Into<OsString>) -> Self {
let suffix = self.content;
let mut content = prefix.into();
content.push(&suffix);
self.content = content;
self
}
}