Struct QuickRef 

#[non_exhaustive]
pub struct QuickRef {
    pub signature: String,
    pub return_hint: String,
    pub description: String,
}

A quick-reference entry parsed from @quickref signature -> return_hint | description.

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.

signature: String

e.g. c:health()

return_hint: String

e.g. {database, version, commit}

description: String

e.g. Check Grafana health

Trait Implementations

impl Clone for QuickRef

fn clone(&self) -> QuickRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuickRef

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

Formats the value using the given formatter.

impl Default for QuickRef

fn default() -> QuickRef

Returns the “default value” for a type.

impl Serialize for QuickRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.