pub struct FunctionPlan { /* private fields */ }Expand description
Immutable declaration metadata shared by guest function implementations.
Equality is plan identity: two independently built plans compare equal when their stable display symbol and complete declarations are equal.
Implementations§
Source§impl FunctionPlan
impl FunctionPlan
Sourcepub fn new(
display_identity: Symbol,
parameters: Vec<ParameterDescriptor>,
captures: Vec<CaptureDescriptor>,
result_shape: Option<ShapeId>,
) -> Result<Self, PlanError>
pub fn new( display_identity: Symbol, parameters: Vec<ParameterDescriptor>, captures: Vec<CaptureDescriptor>, result_shape: Option<ShapeId>, ) -> Result<Self, PlanError>
Validates and freezes one declaration.
Sourcepub fn display_identity(&self) -> &Symbol
pub fn display_identity(&self) -> &Symbol
Returns the stable human-facing identity of this declaration.
Sourcepub fn parameters(&self) -> &[ParameterDescriptor]
pub fn parameters(&self) -> &[ParameterDescriptor]
Returns parameter descriptors in declaration order.
Sourcepub fn captures(&self) -> &[CaptureDescriptor]
pub fn captures(&self) -> &[CaptureDescriptor]
Returns capture slots in stable declaration order.
Sourcepub const fn result_shape(&self) -> Option<ShapeId>
pub const fn result_shape(&self) -> Option<ShapeId>
Returns the declared result Shape identifier.
Sourcepub fn browse(&self) -> BrowseProjection
pub fn browse(&self) -> BrowseProjection
Builds the canonical browse projection without resolving or executing a Shape.
Trait Implementations§
Source§impl Clone for FunctionPlan
impl Clone for FunctionPlan
Source§fn clone(&self) -> FunctionPlan
fn clone(&self) -> FunctionPlan
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FunctionPlan
impl Debug for FunctionPlan
impl Eq for FunctionPlan
Source§impl Hash for FunctionPlan
impl Hash for FunctionPlan
Source§impl PartialEq for FunctionPlan
impl PartialEq for FunctionPlan
impl StructuralPartialEq for FunctionPlan
Auto Trait Implementations§
impl Freeze for FunctionPlan
impl RefUnwindSafe for FunctionPlan
impl Send for FunctionPlan
impl Sync for FunctionPlan
impl Unpin for FunctionPlan
impl UnsafeUnpin for FunctionPlan
impl UnwindSafe for FunctionPlan
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more