Skip to main content

NodeDescriptor

Struct NodeDescriptor 

Source
pub struct NodeDescriptor {
    pub kind: String,
    pub title: String,
    pub description: String,
    pub category: NodeCategory,
    pub config_schema: Value,
    pub outputs: Vec<OutputDescriptor>,
    pub dynamic_outputs: bool,
    pub handles: Handles,
    pub container: bool,
    pub icon: Option<String>,
    pub source: String,
}
Expand description

Description of a node kind.

Unknown keys are rejected: a misspelled config_schema or handles in a plugin manifest would otherwise silently change how the node behaves.

Fields§

§kind: String

Node type used in workflow documents.

§title: String§description: String§category: NodeCategory§config_schema: Value

JSON Schema of the node’s config object (the node fields other than id/type/title/parent/policy). {} when unspecified.

§outputs: Vec<OutputDescriptor>

Static outputs. Nodes whose outputs depend on config (start, end, code…) list none and set dynamic_outputs.

§dynamic_outputs: bool§handles: Handles§container: bool

Whether the node owns a child scope (iteration, loop).

§icon: Option<String>

Short icon hint (e.g. brain, globe, code), purely cosmetic.

§source: String

Origin: builtin, the crate name, or plugin:<name>.

Implementations§

Source§

impl NodeDescriptor

Source

pub fn new( kind: impl Into<String>, title: impl Into<String>, category: NodeCategory, ) -> Self

Source

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

Source

pub fn schema(self, schema: Value) -> Self

Source

pub fn output(self, output: OutputDescriptor) -> Self

Source

pub fn dynamic_outputs(self) -> Self

Source

pub fn handles(self, handles: Handles) -> Self

Source

pub fn container(self) -> Self

Source

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

Source

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

Source

pub fn bare(kind: &str) -> Self

Minimal descriptor used for kinds registered without one.

Source

pub fn is_bare(&self) -> bool

Whether this is a bare (placeholder) descriptor without real metadata.

Trait Implementations§

Source§

impl Clone for NodeDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeDescriptor

Source§

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

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

impl<'de> Deserialize<'de> for NodeDescriptor

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 PartialEq for NodeDescriptor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for NodeDescriptor

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
Source§

impl StructuralPartialEq for NodeDescriptor

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.