Struct Info 

pub struct Info {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub server: Option<String>,
    pub prefix: String,
}

What the generated document says about the API as a whole.

Fields

title: String

version: String

description: Option<String>

server: Option<String>

The base URL clients should call.

prefix: String

Paths under this prefix are documented; everything else is skipped.

Defaults to /api, because a browser-facing page is not an API and documenting it produces noise nobody reads.

Implementations

impl Info

pub fn from_config(config: &Config) -> Info

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl Default for Info

fn default() -> Self

Returns the “default value” for a type.