Struct Choice 

pub struct Choice { /* private fields */ }

A single selectable option: pure data carrying an id, a human label, an optional annotation line, and whether it is the recommended default.

Implementations

impl Choice

pub fn new(id: impl Into<ChoiceId>, label: impl Into<String>) -> Self

Create a choice from an id and human-readable label.

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

Attach a secondary annotation line (for example detected in dev-deps).

pub const fn recommended(self) -> Self

Mark this choice as the recommended default.

In PromptMode::NonInteractive a select resolves to the recommended choice, and an interactive prompt offers it when the answer is left blank.

pub const fn id(&self) -> &ChoiceId

The stable identifier of this choice.

pub fn label(&self) -> &str

The human-readable label.

pub fn annotation(&self) -> Option<&str>

The optional annotation line, if any.

pub const fn is_recommended(&self) -> bool

Whether this choice is the recommended default.

Trait Implementations

impl Clone for Choice

fn clone(&self) -> Choice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Choice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Choice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Choice

impl PartialEq for Choice

fn eq(&self, other: &Choice) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Choice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Choice