Skip to main content

Frame

Struct Frame 

Source
pub struct Frame {
    pub id: FrameId,
    pub scope: String,
    pub constraints: Vec<FrameConstraint>,
    pub success_criteria: Vec<Criterion>,
    pub linked_intent: Option<IntentId>,
    pub parent_frame: Option<FrameId>,
}
Expand description

Frame - defines scope and constraints for a phase of reasoning.

Linked to Intent, contains constraints and success criteria.

§Example

use converge_core::types::{Frame, FrameId, FrameConstraint, ConstraintKind, ConstraintSeverity, Criterion};

let frame = Frame::builder()
    .id(FrameId::new("frame-1"))
    .scope("Nordic B2B market expansion")
    .constraints(vec![
        FrameConstraint::budget(1_000_000),
        FrameConstraint::time("Q4 2025"),
    ])
    .success_criteria(vec![
        Criterion::required("roi", "Achieve 20% ROI"),
    ])
    .build();

assert_eq!(frame.id.as_str(), "frame-1");

Fields§

§id: FrameId

Unique identifier for this frame.

§scope: String

Scope description for this frame.

§constraints: Vec<FrameConstraint>

Constraints that apply to this frame.

§success_criteria: Vec<Criterion>

Success criteria for this frame.

§linked_intent: Option<IntentId>

Linked intent (if this frame is for a specific intent).

§parent_frame: Option<FrameId>

Parent frame (for nested frames).

Implementations§

Source§

impl Frame

Source

pub fn builder() -> FrameBuilder

Create a builder for building Frame. On the builder, call .id(...), .scope(...), .constraints(...)(optional), .success_criteria(...)(optional), .linked_intent(...)(optional), .parent_frame(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Frame.

Source§

impl Frame

Source

pub fn has_required_criteria(&self) -> bool

Check if all required criteria are defined.

Source

pub fn hard_constraints(&self) -> impl Iterator<Item = &FrameConstraint>

Get hard constraints only.

Source

pub fn soft_constraints(&self) -> impl Iterator<Item = &FrameConstraint>

Get soft constraints only.

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Frame

Source§

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

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

impl<'de> Deserialize<'de> for Frame

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Frame, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Frame

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnsafeUnpin for Frame

§

impl UnwindSafe for Frame

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,