Struct PluginOp 

pub struct PluginOp {
    pub id: String,
    pub display_name: String,
    pub description: String,
    pub kind: i32,
    pub params: Vec<ParamSpec>,
    pub compatible_focus_types: Vec<i32>,
    pub creates_entities: bool,
    pub requires_focus: bool,
    pub ui: Option<Ui>,
}

Per-op metadata. User-facing.

Lock semantics (enforced by the orchestrator above the wire):

• compatible_focus_types empty → op runs global; locks globally.
• compatible_focus_types non-empty: focused entity present AND its type ∈ compatible_focus_types → lock just the focused entity (+ create-barrier if creates_entities). otherwise (no focus, or type mismatch) → fall back to global lock, UNLESS requires_focus is set, in which case the op refuses (empty target; button disabled).
• creates_entities → global “create barrier” alongside the focus lock; prevents concurrent create-ops from racing.

Fields

id: String

magic word, e.g. “wiggle”

display_name: String

UI label, e.g. “Wiggle”

description: String

tooltip / help text

kind: i32

params: Vec<ParamSpec>

empty for click-to-fire ops

compatible_focus_types: Vec<i32>

see lock semantics above

creates_entities: bool

see lock semantics above

requires_focus: bool

True only for ops that genuinely require a focused target (e.g. binder design); the lock model refuses them when no compatible entity is focused. Distinct from compatible_focus_types, which only TYPE-RESTRICTS an optional focus.

ui: Option<Ui>

Optional click-to-fire icon. Mutually exclusive with non-empty params

• ops with params render forms, no icon needed.

Implementations

impl PluginOp

pub fn kind(&self) -> OpKind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: OpKind)

Sets kind to the provided enum value.

pub fn compatible_focus_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<EntityType>>

Returns an iterator which yields the valid enum values contained in compatible_focus_types.

pub fn push_compatible_focus_types(&mut self, value: EntityType)

Appends the provided enum value to compatible_focus_types.

Trait Implementations

impl Clone for PluginOp

fn clone(&self) -> PluginOp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginOp

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

Formats the value using the given formatter.

impl Default for PluginOp

fn default() -> Self

Returns the “default value” for a type.

impl Message for PluginOp

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PluginOp

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PluginOp