Skip to main content

FuncSig

Struct FuncSig 

Source
pub struct FuncSig {
Show 13 fields pub name: &'static str, pub category: FuncCategory, pub outputs: usize, pub description: &'static str, pub help: &'static str, pub identity: Option<u64>, pub variadic_ctor: Option<fn(usize) -> Box<dyn PolydatNode>>, pub params: &'static [ParamSpec], pub arity: Arity, pub commutativity: Commutativity, pub default_resolver: Option<DefaultResolver>, pub output_type: OutputType, pub output_port: Option<PortType>,
}
Expand description

Description of a registered function’s signature.

Fields§

§name: &'static str

Function name as used in the DSL.

§category: FuncCategory

Functional category.

§outputs: usize

Number of output ports (0 = dynamic, determined at compile time).

§description: &'static str

Short description for help/error messages.

§help: &'static str

Detailed help text: theory, usage examples, parameter meanings. Displayed in the graph editor help panel.

§identity: Option<u64>

For variadic functions: the identity element for zero inputs.

§variadic_ctor: Option<fn(usize) -> Box<dyn PolydatNode>>

Factory for variadic nodes: takes wire count, returns node.

§params: &'static [ParamSpec]

Positional parameter list: wires and constants in call order.

§arity: Arity

Arity specification.

§commutativity: Commutativity

Input commutativity for this function.

§default_resolver: Option<DefaultResolver>

Optional resolver hint for Handle-typed input ports. When the binding compiler emits this function and a Handle input is wired to a Str-producing source, it splices in the named resolver to convert the string into a handle. This is the “string-conversion node insertion” mechanism from SRD 53 §“Source-string call-site sugar”. None means no auto-promotion — the caller must pass a Handle directly.

§output_type: OutputType

Output-type contract — Fixed for the vast majority of nodes; SameAsInput(idx) for type-polymorphic pass-throughs (e.g. log_info whose output type tracks its sole input).

§output_port: Option<PortType>

Concrete port type of the single output, when statically known (#[polydat_node] emits it from the return type’s Wire::PORT). None for tuple/dynamic/polymorphic outputs and for hand registrations that don’t declare one. The DSL type inference (binding::infer_expr_type) reads this FIRST — the name-prefix heuristic is only the fallback — so call-expression operand typing flows from the symbol registry, not from a hand-maintained list.

Implementations§

Source§

impl FuncSig

Source

pub fn wire_input_count(&self) -> usize

Number of wire inputs in the fixed parameter list.

Source

pub fn is_variadic(&self) -> bool

Whether this function accepts variadic arguments.

Source

pub fn const_param_info(&self) -> Vec<(&'static str, bool)>

Constant parameter names and whether they’re required.

Trait Implementations§

Source§

impl Clone for FuncSig

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 FuncSig

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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