Data Updates#
This guide covers how to change a live Project as the user works: adding, updating and removing tasks, links, resources and assignments, rescheduling after the edit, and recovering when part of an edit is refused.
How editing works#
A Project holds one accepted state: the data from the last solve(Some(data), ..) plus every edit since, with the dates the last solve accepted. You don't send the whole plan again for each change. You describe the change as a SchedulingChanges value and pass it to Project::apply.
Editing happens in two steps, and they're separate calls:
apply(&changes)writes the edit into the accepted state and marks the project unsolved. It doesn't schedule anything.solve(None, &options)schedules the edited state, accepts the new dates and returns what moved.
Between the two calls the project has no baseline. preview, load_profile, evaluate, suggest_assignments and roster fail with ProjectError::NoBaseline until you solve. You can call apply several times before one solve. The edits accumulate.
apply accepts what it can. Each operation in the change set either applies or is rejected on its own. A rejection isn't an Err: it's listed in the returned ApplyReport, and it sets needs_resync. From then on the project refuses solve(None, ..), apply and level with ProjectError::NeedsResync. Your model and the project's state may now disagree, and the only way back is to send the full data with solve(Some(data), ..).
Err from apply itself means the call didn't fit the project's state: NeedsResync from an earlier rejection, or StaleBaseline when the change set names a baseline that isn't current anymore. In both cases nothing was applied. See Error handling.
Change sets#
A SchedulingChanges groups the edits by record kind. Each group is a Changes<A, U> with three lists: add, update and remove.
| Group | add |
update |
remove |
|---|---|---|---|
tasks |
TaskData |
TaskUpdate |
task Id |
links |
LinkAdd |
LinkUpdate |
link Id |
resources |
ResourceData |
ResourceUpdate |
resource Id |
assignments |
AssignmentData |
AssignmentUpdate |
assignment Id |
Additions use the same record types as ProjectData, except links: LinkAdd has an optional id. Leave a link or assignment id as None and apply generates one ($generated_link_1, $generated_assignment_1, ...). Generated ids come back in ApplyReport.effects, so you can store them in your model.
use ;
The report lists tasks.add[0], tasks.update[0] and links.add[0], and the new link is $generated_link_1. After the solve, task 1 runs until 2026-08-13 08:00, task 2 moves to 2026-08-13 08:00 .. 2026-08-18 08:00, and task 3 starts when task 2 ends.
Operations don't run in the order you pushed them. apply runs them in a fixed order, so every reference comes after the adds it may need and every removal comes before the edits it could break:
- tasks: remove, add, update
- links: remove, update, add
- resources: remove, add, update
- assignments: remove, update, add
An operation is named by its group, list and index, such as tasks.update[0]. The same path shows up in ApplyReport.applied and ApplyReport.rejected.
Update records and Patch#
Update records (TaskUpdate, LinkUpdate, ResourceUpdate, AssignmentUpdate) name the record by id and carry every other field as a Patch<T>. A patch has three states:
Patch::Missing(the default) leaves the field as it is.Patch::Value(v)sets it.Patch::Nullclears an optional field, or restores the default of a field that always has a value:auto_schedulinggoes back totrue,unscheduledtofalse,progressto0,priorityto500,leveling_delayto0,pausesto empty,link_typeto FS andlagto0.
TaskUpdate::new(id) and the other new constructors set every field to Missing, so you only touch the fields you mean to change.
use ;
The first solve moves the task to 2026-08-13 08:00. The second puts it back on Monday. Clearing the constraint alone wouldn't do that: the accepted state already holds the Thursday dates, so the update also sets start_date.
Which dates a task update keeps#
A task has three linked date fields: start_date, end_date and duration. When an update sets some of them, apply keeps what you sent and derives the rest:
start_datealone keeps the duration and recomputes the end (a drag).end_datealone keeps the start and recomputes the duration (a resize from the right edge).durationalone keeps the start and recomputes the end.start_dateandend_datetogether recompute the duration.- A new
calendar_id, or a newparentwhile calendars are inherited (CalendarMode::TaskInherited), keeps the start and duration and recomputes the end on the new calendar. Under an inherited calendar, the descendants that inherit it re-derive their ends too.
An explicit start_date that falls on non-working time is kept as sent when the task has no predecessor. The end is computed forward from it on the working calendar, so only the start sits outside working time. Snap the date in your UI if you don't want that.
Feeding results back#
A Mutation from a result uses the same field names as TaskUpdate, so a result entry maps field by field onto an update. That's useful when you want to commit dates you got from preview or a leveled clone:
use ;
pauses replaces the whole list. Set it to Patch::Value(vec![]) or Patch::Null to remove every pause. See Clear leveling.
Applying#
apply returns an ApplyReport:
appliedlists the path of every accepted operation.rejectedlists the path and message of every refused one.effectslists what the edit changed beyond the records you named (below).needs_resyncistruewhen anything was rejected.revisionis the project's revision number after this edit.
Removals cascade, and effects tells you what went with them. Removing a task removes its descendants, every link that touches any of them and every assignment on them. Removing a resource removes its assignments.
use ;
Removing the summary phase also removes spec, the link spec-release and the assignment ann-spec. Delete the same records from your own model.
The other effects lists:
generated_linksandgenerated_assignmentshold the idsapplymade up for additions without one.dropped_linksanddropped_assignmentshold records that were accepted but are now inactive, for example a link to an unscheduled task. They stay in the project and come back into play when the task does.
apply takes &mut self and edits the project in place. Clones made earlier don't see the edit, so you can clone a project, apply a multi-step edit to the clone and drop it if the user cancels. For a single edit, preview does the same job without a clone. See Previewing changes.
Field-only task edits and assignment updates take a fast path that patches the affected records without rebuilding the whole model. Frequent small edits, like drags, stay cheap.
Rescheduling#
After apply, call solve(None, &options). It schedules the edited state, accepts the dates as the new baseline and returns the updates relative to the previous one.
Tasks that a successful operation added or updated are always reported, even when the planner leaves them exactly where the edit put them. The same goes for tasks whose working calendars changed because of a resource or assignment edit. Your model gets the derived end or duration for every task you edited, not only for the ones that moved. These reported tasks accumulate across several apply calls until the next acyclic solve(None, ..) or level. A cyclic solve keeps them pending.
Guarding against stale edits#
A UI usually edits the dates it showed the user. If the project changed in between (another edit from another tab, a leveling run), applying the edit can do the wrong thing. Set SchedulingChanges.baseline_id to the token of the result the user saw, and apply refuses the whole change set with StaleBaseline when that token isn't current.
use ;
A token names a baseline only while the project is solved and clean. After an apply, any baseline_id is stale until the next solve, so take a fresh token from each result. Tokens are opaque: don't store them or compare them across runs. None (the default) skips the check.
Rejections and resync#
An operation is rejected when it can't apply: an unknown id in update or remove, a duplicate id in add, Patch::Null on a required field (a link's source or target, an assignment's task, resource or value), or a record that fails validation after the edit, such as an invalid pause or assignment slice. Each operation is tried on its own copy, so a rejected operation leaves no partial edit behind, and the operations around it still apply.
use ;
The update applies and the removal is rejected with rejected tasks.remove[0]: unknown task id. The project now holds the update but not the removal, which is probably not what your model holds. That's why any rejection blocks further edits: solve(None, ..), apply and level return ProjectError::NeedsResync until a successful solve(Some(data), ..) replaces the whole state with data you know is right.
The resync data must pass validation. If it doesn't, you get Error::Input, and the project still needs a resync. See Recover from rejected changes.
evaluate and suggest_assignments use the same apply on disposable copies, so a rejected candidate shows up as its CandidateResult.error (a RejectedOperation) instead of blocking the project. See Evaluating alternatives.
What change sets can't do#
Some edits have no operation. For these, rebuild the data in your model and send it with solve(Some(data), ..):
- Calendars can't be added, changed or removed. Tasks and resources can switch to another existing calendar through
calendar_id. SchedulingConfigcan't change: duration unit,use_calendars,calendar_mode,apply_constraintsand the other settings are fixed until the next full solve.- A task's
task_typeandduration_unitaren't inTaskUpdate. To turn a task into a summary or a milestone, remove it and add it again (its links and assignments go with the removal), or resync. - An id can't be renamed.
updatefinds the record by its id and never changes it. ResourceUpdatechanges onlycapacityandcalendar_id.
Calls that don't need a change set also don't use one. level writes its own leveling_delay and pauses edits and accepts the result. See Leveling resources.