Struct ExternalDocs 

#[non_exhaustive]
pub struct ExternalDocs {
    pub url: String,
    pub description: Option<String>,
}

A pointer at documentation kept outside the generated document.

Examples

use ruststream::ExternalDocs;
use ruststream::runtime::{App, AppInfo, RustStream};

fn app() -> impl App {
    let info = AppInfo::new("payments", "1.4.0").external_docs(
        ExternalDocs::new("https://example.com/payments").description("the payment flow"),
    );
    RustStream::new(info)
}

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.

url: String

Where the documentation lives.

description: Option<String>

What the reader finds there.

Implementations

impl ExternalDocs

pub fn new(url: impl Into<String>) -> Self

Documentation at url, undescribed.

Examples

use ruststream::ExternalDocs;
use ruststream::runtime::{App, AppInfo, RustStream};

fn app() -> impl App {
    let info = AppInfo::new("payments", "1.4.0")
        .external_docs(ExternalDocs::new("https://example.com/payments"));
    RustStream::new(info)
}

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

Sets what the reader finds there.

Examples

use ruststream::ExternalDocs;
use ruststream::runtime::{App, AppInfo, RustStream};

fn app() -> impl App {
    let info = AppInfo::new("payments", "1.4.0").external_docs(
        ExternalDocs::new("https://example.com/runbooks/payments")
            .description("the runbook"),
    );
    RustStream::new(info)
}

Trait Implementations

impl Clone for ExternalDocs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalDocs

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

Formats the value using the given formatter.

impl Eq for ExternalDocs

impl PartialEq for ExternalDocs

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExternalDocs

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 ExternalDocs