Struct ProviderEntry 

pub struct ProviderEntry {
    pub tag: Tag,
    pub kind: ProviderKind,
    pub base: String,
    pub wire: Wire,
    pub models: Vec<Model>,
    pub key: Option<Key>,
    pub lineups: Vec<Lineup>,
}

A provider as the file holds it.

Fields

tag: Tag

The person’s own name for it, which stands in front of a model name.

kind: ProviderKind

Which service it is.

base: String

Where it answers, without a trailing slash.

wire: Wire

The shape it speaks.

models: Vec<Model>

What it was last seen to offer. Empty until it has been asked.

key: Option<Key>

The key it is reached with, for a provider that needs one.

lineups: Vec<Lineup>

The named orders of its models. Empty until the person has written one: an order is their own decision about which of the models to lean on, and no service publishes one.

Implementations

impl ProviderEntry

pub fn new(tag: Tag, kind: ProviderKind, base: &str) -> Self

A provider of kind at base, named tag, with nothing asked of it yet.

A ready-made kind starts with the models its maker publishes, so the page and the profile wizard have something to offer before the service has been asked anything.

pub fn address(&self, path: &str) -> String

The address path sits at under this provider’s base, which is what the page shows before a request goes out.

pub fn api_address(&self, wire: Wire, path: &str) -> String

The address path of this provider’s API sits at for a request of shape wire; see ProviderKind::api_address.

pub fn messages_address(&self) -> String

Where a message to model would go. The page prints this before the person presses anything, so that nothing leaves the machine towards an address they have not read.

pub fn model(&self, id: &str) -> Option<&Model>

The model named id, when this provider was last seen to have one.

pub fn lineup(&self, name: &str) -> Option<&Lineup>

The lineup called name, when this provider has one. A name is a person’s own word, so it is looked up as it is written rather than parsed into a tag first.

Trait Implementations

impl Clone for ProviderEntry

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 ProviderEntry

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

Formats the value using the given formatter.

impl Eq for ProviderEntry

impl PartialEq for ProviderEntry

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProviderEntry