Struct Tag 

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

A group label: on the service, on a server, on an operation.

Examples

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

fn app() -> impl App {
    let info = AppInfo::new("payments", "1.4.0")
        .tag(Tag::new("payments").description("everything the payment domain emits"));
    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.

name: String

The label itself.

description: Option<String>

What the label means.

external_docs: Option<ExternalDocs>

Where the label is documented.

Implementations

impl Tag

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

A bare label.

Examples

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

fn app() -> impl App {
    let info = AppInfo::new("payments", "1.4.0")
        .tag(Tag::new("payments"))
        .tag(Tag::new("public"));
    RustStream::new(info)
}

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

Sets what the label means.

Examples

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

fn app() -> impl App {
    let info = AppInfo::new("payments", "1.4.0")
        .tag(Tag::new("payments").description("the payment domain"));
    RustStream::new(info)
}

pub fn external_docs(self, docs: ExternalDocs) -> Self

Sets where the label is documented.

Examples

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

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

Trait Implementations

impl Clone for Tag

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 Tag

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

Formats the value using the given formatter.

impl Eq for Tag

impl PartialEq for Tag

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Tag

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 Tag