Enum PluginKind 

pub enum PluginKind {
    GithubProjects,
    InMemory,
    Linear,
    LocalMd,
    Subprocess,
}

One of the plugin kinds this build has.

A SourceConfig holds one of these rather than the string a document spelled, so a configuration naming a plugin nothing answers to cannot exist past Config::from_document. Resolution therefore has no “what if the registry does not have it” branch left to get wrong, and the refusal happens at the one place that can name the offending key.

Variants

GithubProjects

GitHub Projects.

InMemory

The in-memory source the journeys are written against.

Linear

Linear.

LocalMd

A folder of Markdown files.

Subprocess

A program of its own, speaking docs/plugin-protocol.md over stdio.

Implementations

impl PluginKind

pub const ALL: [Self; 5]

Every kind, in the stable order registry reports them in.

pub fn as_str(self) -> &'static str

The name a configuration document’s plugin: field names this kind by.

Spelled here rather than read from the plugin so that matching a name costs no allocation. every_plugin_kind_names_the_kind_its_own_plugin_reports is what keeps the two from drifting.

pub fn parse(name: &str) -> Option<Self>

The kind called name, or None when nothing in this build answers to it.

pub fn plugin(self) -> Box<dyn SourcePlugin>

This kind’s factory.

Total, which is the point of the type: a PluginKind is one of exactly five things, so there is no absent-plugin case for a caller to handle or forget.

Trait Implementations

impl Clone for PluginKind

fn clone(&self) -> PluginKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PluginKind

impl Debug for PluginKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PluginKind

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

Formats the value using the given formatter.

impl Eq for PluginKind

impl From<PluginKind> for String

fn from(value: PluginKind) -> Self

Converts to this type from the input type.

impl FromStr for PluginKind

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PluginKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PluginKind

fn cmp(&self, other: &PluginKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PluginKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PluginKind

fn partial_cmp(&self, other: &PluginKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PluginKind

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 PluginKind

impl TryFrom<String> for PluginKind

fn try_from(value: String) -> Result<Self, Self::Error>

Read a kind this build has, and refuse one it does not — naming what it does have.

Where a document or a protocol message carries a plugin kind, this is what keeps “a kind” and “a kind this binary can build” the same thing: an unknown name stops being representable at the field rather than at a lookup somewhere later.

type Error = String

The type returned in the event of a conversion error.