Struct ApiExample 

pub struct ApiExample {
    pub id: String,
    pub target: String,
    pub caption: String,
    pub source: String,
    pub code: String,
}

One extracted example.

Fields

id: String

<guest>:<target>, e.g. comment:grammar-callbacks.apply-operator. Unique; guides quote an example by this id.

target: String

What it illustrates: <interface> or <interface>.<item>.

caption: String

One line saying what the example does.

source: String

Repo-relative source file, /-separated.

code: String

The region’s code, dedented, without the marker lines.

Implementations

impl ApiExample

pub fn interface(&self) -> &str

The interface the target names.

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

The item within the interface, or None for an interface-level example.

Trait Implementations

impl Clone for ApiExample

fn clone(&self) -> ApiExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiExample

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

Formats the value using the given formatter.

impl Eq for ApiExample

impl PartialEq for ApiExample

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiExample