Struct SpecConfigSource 

#[non_exhaustive]
pub struct SpecConfigSource {
    pub name: Option<String>,
    pub doc_hint: Option<String>,
    pub set_hint: Option<String>,
}

A source kind’s display metadata.

usage never reads a git config or an .npmrc; it renders what the spec says about them. {key} and {value} in a hint are substituted with the setting’s key in that source and the value being set.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

What to call it in prose: “git config”, “hk.pkl”.

doc_hint: Option<String>

How to describe reading a setting from it: “git config {key}”.

set_hint: Option<String>

How to describe writing one: “git config {key} {value}”.

Trait Implementations

impl Clone for SpecConfigSource

fn clone(&self) -> SpecConfigSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecConfigSource

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

Formats the value using the given formatter.

impl Default for SpecConfigSource

fn default() -> SpecConfigSource

Returns the “default value” for a type.

impl PartialEq for SpecConfigSource

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SpecConfigSource

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 SpecConfigSource