Skip to main content

PluginManifest

Struct PluginManifest 

Source
pub struct PluginManifest {
Show 13 fields pub name: String, pub version: String, pub command: Option<String>, pub args: Vec<String>, pub protocol: PluginProtocol, pub deliver_url: Option<String>, pub auth_token_env: Option<String>, pub capabilities: Vec<String>, pub description: Option<String>, pub timeout_secs: u64, pub build_command: Option<String>, pub min_daemon_version: Option<String>, pub source_url: Option<String>,
}
Expand description

Parsed channel.toml plugin manifest.

Fields§

§name: String

Plugin name (e.g., “teams”, “pagerduty”, “custom-webhook”).

§version: String

Plugin version (semver).

§command: Option<String>

Command to spawn for json-stdio plugins. Can be a bare executable name (resolved via PATH) or a full path. Ignored for http protocol.

§args: Vec<String>

Additional arguments to pass to the command.

§protocol: PluginProtocol

Communication protocol.

§deliver_url: Option<String>

URL to POST questions to (only for http protocol).

§auth_token_env: Option<String>

Environment variable name holding an auth token (http protocol).

§capabilities: Vec<String>

Capabilities this plugin supports.

§description: Option<String>

Human-readable description.

§timeout_secs: u64

Timeout in seconds for a single delivery attempt.

§build_command: Option<String>

Custom build command for non-Rust plugins.

Rust plugins default to cargo build --release when this is absent. Non-Rust plugins specify their own build step:

  • Go: "go build -o ta-channel-teams ."
  • Python: "pip install -e ."
  • Node: "npm run build"
§min_daemon_version: Option<String>

Minimum daemon version required by this plugin (v0.10.16). Semver string (e.g., “0.10.0-alpha”). If set and the daemon version is lower, plugin validation warns about incompatibility.

§source_url: Option<String>

Source URL for remote install / upgrade (v0.10.16). Used by ta plugin upgrade to fetch the latest version.

Implementations§

Source§

impl PluginManifest

Source

pub fn load(path: &Path) -> Result<Self, PluginError>

Load a plugin manifest from a channel.toml file.

Source

pub fn validate(&self) -> Result<(), PluginError>

Validate internal consistency of the manifest.

Trait Implementations§

Source§

impl Clone for PluginManifest

Source§

fn clone(&self) -> PluginManifest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PluginManifest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PluginManifest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PluginManifest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,