Struct ServiceInfo 

pub struct ServiceInfo {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
}

Title, version and optional prose description of a service.

Fields

title: String

Human readable name of the service.

version: String

Version of the service.

description: Option<String>

Prose description, carried by both documents when present.

Implementations

impl ServiceInfo

pub fn new<T: Into<String>, V: Into<String>>(title: T, version: V) -> Self

A service with a title and a version.

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

The same service carrying a prose description.

Examples

use lino_rest_api::description::ServiceInfo;

let info = ServiceInfo::new("Tasks API", "1.0.0").describing("A task list");
assert_eq!(info.description.as_deref(), Some("A task list"));

Trait Implementations

impl Clone for ServiceInfo

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 ServiceInfo

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

Formats the value using the given formatter.

impl Default for ServiceInfo

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ServiceInfo

impl PartialEq for ServiceInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ServiceInfo