pub struct SessionRpcPlan<'a> { /* private fields */ }Expand description
session.plan.* RPCs.
Implementations§
Source§impl<'a> SessionRpcPlan<'a>
impl<'a> SessionRpcPlan<'a>
Sourcepub async fn read(&self) -> Result<PlanReadResult, Error>
pub async fn read(&self) -> Result<PlanReadResult, Error>
Reads the session plan file from the workspace.
Wire method: session.plan.read.
§Returns
Existence, contents, and resolved path of the session plan file.
Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.
Sourcepub async fn update(&self, params: PlanUpdateRequest) -> Result<(), Error>
pub async fn update(&self, params: PlanUpdateRequest) -> Result<(), Error>
Writes new content to the session plan file.
Wire method: session.plan.update.
§Parameters
params- Replacement contents to write to the session plan file.
Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.
Sourcepub async fn delete(&self) -> Result<(), Error>
pub async fn delete(&self) -> Result<(), Error>
Deletes the session plan file from the workspace.
Wire method: session.plan.delete.
Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.
Sourcepub async fn read_sql_todos(&self) -> Result<PlanReadSqlTodosResult, Error>
pub async fn read_sql_todos(&self) -> Result<PlanReadSqlTodosResult, Error>
Reads todo rows from the session SQL database for plan rendering.
Wire method: session.plan.readSqlTodos.
§Returns
Todo rows read from the session SQL database. Empty when no session database is available.
Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.
Sourcepub async fn read_sql_todos_with_dependencies(
&self,
) -> Result<PlanReadSqlTodosWithDependenciesResult, Error>
pub async fn read_sql_todos_with_dependencies( &self, ) -> Result<PlanReadSqlTodosWithDependenciesResult, Error>
Reads todo rows AND dependency edges from the session SQL database for structured progress UI. Same defensive behavior as readSqlTodos — returns empty arrays when the database, tables, or columns aren’t available. Clients should call this on session start and after every session.todos_changed event to refresh structured-UI rendering.
Wire method: session.plan.readSqlTodosWithDependencies.
§Returns
Todo rows + dependency edges read from the session SQL database.
Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.
Trait Implementations§
Source§impl<'a> Clone for SessionRpcPlan<'a>
impl<'a> Clone for SessionRpcPlan<'a>
Source§fn clone(&self) -> SessionRpcPlan<'a>
fn clone(&self) -> SessionRpcPlan<'a>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more