API reference

aster_blueprint::event_binding

Pre-1.0: signatures are not frozen. Generated from rustdoc JSON of the compiled crate; rustdoc JSON format version 60. Only public items are listed.

Application-owned binding seam for compiled Plan event/intent endpoints.

This seam is deliberately small and non-authoritative. An [OwnedEndpoint] is a bounded, owned view of exactly one event/intent output of a compiled [Plan]; it refuses pure data outputs and unknown names. Binding an endpoint produces the existing [BoundAction] stamped against a caller-provided acknowledged context, and only after the caller-supplied SnapshotId equals the acknowledged stamp's snapshot.

Caller precondition (not provable here). The caller must hold the exact Plan this endpoint was built from inside the same actual submitted snapshot model it stages, and must supply that projection itself. This helper only compares SnapshotIds; it never inspects or infers the snapshot contents, the current model, or an active scene. There is no fake proof.

Event/intent kernels are not executed here. This is an observation and authoring seam, never an action authorization, scheduler, backend dispatch, authentication check, or new identity source. A deliberate button/control activation remains entirely the caller's responsibility.

Formatting is bounded as well: an [OwnedEndpoint] prints only its plan identity, its output name and its output type. The compiled plan payload is never formatted into a log line.

Structs

structaster_blueprint::event_binding::GraphEndpoint

pub struct GraphEndpoint { /* see fields */ }

Authority-free metadata identifying one bound graph endpoint.

This is local asset metadata only: a plan identity plus the declared output name and type. It is never an authority token and carries no plan payload.

Methods

  • fn plan(&self) -> PlanId — The local plan identity the endpoint belongs to.
  • fn output(&self) -> &Symbol — The declared event/intent output name.
  • fn value_type(&self) -> ValueType — The declared event/intent output type.

Trait implementations: Clone, Debug, Eq, PartialEq, StructuralPartialEq

structaster_blueprint::event_binding::OwnedEndpoint

pub struct OwnedEndpoint { /* see fields */ }

A bounded, owned endpoint of one compiled plan's event/intent signal.

Fields are private; construction is only through [OwnedEndpoint::from_plan] against an existing [Plan::event_outputs] entry.

Methods

  • fn from_plan(plan: Arc<Plan>, name: &Symbol) -> Result<Self, EndpointError> — Select exactly one declared event/intent output by name.
  • fn graph_endpoint(&self) -> GraphEndpoint — The authority-free metadata carried by a successful binding.
  • fn plan(&self) -> &Arc<Plan> — The local plan this endpoint is owned against.
  • fn bind<'a>(&self, ctx: &AcknowledgedContext<'a>, node: NodeId, snapshot: SnapshotId) -> Result<BoundAction<GraphEndpoint>, EndpointError> — Bind against the caller's actual acknowledged context and NodeId.
  • fn complete<'a>(&self, active: &Arc<Plan>, ctx: &AcknowledgedContext<'a>, action: &BoundAction<GraphEndpoint>) -> Result<(), EndpointError> — Validate a completed action against the acknowledged context.

Trait implementations: Debug

Enums

enumaster_blueprint::event_binding::EndpointError

pub enum EndpointError { UnknownEventOutput, NotAnEventOutput, SnapshotMismatch, ForeignPlan, ActionMismatch, Bind }

Why an endpoint could not be constructed or a binding could not complete.

Variants

  • UnknownEventOutput — The name is not an event/intent output of the plan at all.
  • NotAnEventOutput — The name is a pure data output (Plan::outputs), not an event endpoint.
  • SnapshotMismatch — The caller-supplied snapshot is not the acknowledged snapshot.
  • ForeignPlan — The active plan is not the exact Arc<Plan> this endpoint was built on, even if it was compiled from identical source.
  • ActionMismatch — The action was bound from a different endpoint, plan or output.
  • Bind — The existing acknowledged context rejected the action.

Trait implementations: Clone, Copy, Debug, Display, Eq, Error, PartialEq, StructuralPartialEq