RootIntent

Struct RootIntent 

Source
pub struct RootIntent {
    pub id: IntentId,
    pub kind: IntentKind,
    pub objective: Option<Objective>,
    pub scope: Scope,
    pub constraints: Vec<IntentConstraint>,
    pub success_criteria: SuccessCriteria,
    pub budgets: Budgets,
}
Expand description

The Root Intent — constitution of a Converge job.

This is the only entry point into a Converge runtime. It defines the universe of discourse, what is allowed, and what success means.

Fields§

§id: IntentId

Unique identifier.

§kind: IntentKind

The class of problem.

§objective: Option<Objective>

What the system should optimize.

§scope: Scope

What is in-bounds.

§constraints: Vec<IntentConstraint>

Hard and soft constraints.

§success_criteria: SuccessCriteria

Success criteria.

§budgets: Budgets

Execution budgets.

Implementations§

Source§

impl RootIntent

Source

pub fn new(kind: IntentKind) -> Self

Creates a new Root Intent with the given kind.

Source

pub fn with_id(self, id: IntentId) -> Self

Sets the intent ID.

Source

pub fn with_objective(self, objective: Objective) -> Self

Sets the objective.

Source

pub fn with_scope(self, scope: Scope) -> Self

Sets the scope.

Source

pub fn with_constraint(self, constraint: IntentConstraint) -> Self

Adds a constraint.

Source

pub fn with_success_criterion(self, criterion: SuccessCriterion) -> Self

Adds a success criterion (required).

Source

pub fn with_success_criteria(self, criteria: SuccessCriteria) -> Self

Sets the success criteria.

Source

pub fn with_budgets(self, budgets: Budgets) -> Self

Sets the budgets.

Source

pub fn validate(&self) -> Result<(), IntentValidationError>

Validates the Root Intent.

§Errors

Returns error if:

  • Scope is not defined
  • Success criteria are not explicit
Source

pub fn to_seed_facts(&self) -> Vec<Fact>

Creates initial seed facts from this intent.

These facts are added to the context at the start of execution.

Source

pub fn hard_constraints(&self) -> Vec<&IntentConstraint>

Returns hard constraints.

Source

pub fn soft_constraints(&self) -> Vec<&IntentConstraint>

Returns soft constraints.

Source

pub fn is_successful(&self, ctx: &Context) -> bool

Checks if success criteria are satisfied by the context.

Trait Implementations§

Source§

impl Clone for RootIntent

Source§

fn clone(&self) -> RootIntent

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 RootIntent

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