Skip to main content

SessionRpcWorkspaces

github_copilot_sdk::rpc

Struct SessionRpcWorkspaces 

Source 
pub struct SessionRpcWorkspaces<'a> { /* private fields */ }
Expand description

session.workspaces.* RPCs.

Implementations§

Source§

impl<'a> SessionRpcWorkspaces<'a>

Source

pub async fn get_workspace(&self) -> Result<WorkspacesGetWorkspaceResult, Error>

Gets current workspace metadata for the session.

Wire method: session.workspaces.getWorkspace.

§Returns

Current workspace metadata for the session, including its absolute filesystem path when 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.

Source

pub async fn update_metadata( &self, params: WorkspacesUpdateMetadataRequest, ) -> Result<WorkspacesGetWorkspaceResult, Error>

Updates workspace metadata for a local session and returns the refreshed workspace.

Wire method: session.workspaces.updateMetadata.

§Parameters
  • params - Workspace metadata fields to update.
§Returns

Current workspace metadata for the session, including its absolute filesystem path when 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.

Source

pub async fn ensure( &self, params: WorkspacesEnsureRequest, ) -> Result<WorkspacesGetWorkspaceResult, Error>

Ensures a local session workspace exists and returns it.

Wire method: session.workspaces.ensure.

§Parameters
  • params - Optional session context used when creating a local workspace.
§Returns

Current workspace metadata for the session, including its absolute filesystem path when 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.

Source

pub async fn list_files(&self) -> Result<WorkspacesListFilesResult, Error>

Lists files stored in the session workspace files directory.

Wire method: session.workspaces.listFiles.

§Returns

Relative paths of files stored in the session workspace files directory.

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.

Source

pub async fn read_file( &self, params: WorkspacesReadFileRequest, ) -> Result<WorkspacesReadFileResult, Error>

Reads a file from the session workspace files directory.

Wire method: session.workspaces.readFile.

§Parameters
  • params - Relative path of the workspace file to read.
§Returns

Contents of the requested workspace file as a UTF-8 string.

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.

Source

pub async fn create_file( &self, params: WorkspacesCreateFileRequest, ) -> Result<(), Error>

Creates or overwrites a file in the session workspace files directory.

Wire method: session.workspaces.createFile.

§Parameters
  • params - Relative path and UTF-8 content for the workspace file to create or overwrite.

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.

Source

pub async fn list_checkpoints( &self, ) -> Result<WorkspacesListCheckpointsResult, Error>

Lists workspace checkpoints in chronological order.

Wire method: session.workspaces.listCheckpoints.

§Returns

Workspace checkpoints in chronological order; empty when the workspace is not enabled.

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.

Source

pub async fn read_checkpoint( &self, params: WorkspacesReadCheckpointRequest, ) -> Result<WorkspacesReadCheckpointResult, Error>

Reads the content of a workspace checkpoint by number.

Wire method: session.workspaces.readCheckpoint.

§Parameters
  • params - Checkpoint number to read.
§Returns

Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.

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.

Source

pub async fn add_summary( &self, params: WorkspacesAddSummaryRequest, ) -> Result<WorkspacesAddSummaryResult, Error>

Adds a compaction summary checkpoint to the local session workspace.

Wire method: session.workspaces.addSummary.

§Parameters
  • params - Compaction summary checkpoint to persist.
§Returns

Persisted summary metadata and refreshed workspace metadata.

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.

Source

pub async fn truncate_summaries( &self, params: WorkspacesTruncateSummariesRequest, ) -> Result<WorkspacesGetWorkspaceResult, Error>

Truncates local workspace compaction summaries after a rollback.

Wire method: session.workspaces.truncateSummaries.

§Parameters
  • params - Rollback point for local workspace summaries.
§Returns

Current workspace metadata for the session, including its absolute filesystem path when 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.

Source

pub async fn read_autopilot_objective( &self, ) -> Result<WorkspacesReadAutopilotObjectiveResult, Error>

Reads the autopilot objective state file from the local session workspace.

Wire method: session.workspaces.readAutopilotObjective.

§Returns

Autopilot objective file content, or null when missing.

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.

Source

pub async fn write_autopilot_objective( &self, params: WorkspacesWriteAutopilotObjectiveRequest, ) -> Result<WorkspacesWriteAutopilotObjectiveResult, Error>

Writes the autopilot objective state file in the local session workspace.

Wire method: session.workspaces.writeAutopilotObjective.

§Parameters
  • params - Autopilot objective file content to persist.
§Returns

Result of writing the autopilot objective 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.

Source

pub async fn delete_autopilot_objective( &self, ) -> Result<WorkspacesDeleteAutopilotObjectiveResult, Error>

Deletes the autopilot objective state file from the local session workspace.

Wire method: session.workspaces.deleteAutopilotObjective.

§Returns

Result of deleting the autopilot objective 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.

Source

pub async fn autopilot_objective_exists( &self, ) -> Result<WorkspacesAutopilotObjectiveExistsResult, Error>

Checks whether the local session workspace has an autopilot objective state file.

Wire method: session.workspaces.autopilotObjectiveExists.

§Returns

Whether the autopilot objective file exists.

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.

Source

pub async fn save_large_paste( &self, params: WorkspacesSaveLargePasteRequest, ) -> Result<WorkspacesSaveLargePasteResult, Error>

Saves pasted content as a UTF-8 file in the session workspace.

Wire method: session.workspaces.saveLargePaste.

§Parameters
  • params - Pasted content to save as a UTF-8 file in the session workspace.
§Returns

Descriptor for the saved paste file, or null when the workspace is unavailable.

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.

Source

pub async fn diff( &self, params: WorkspacesDiffRequest, ) -> Result<WorkspaceDiffResult, Error>

Computes a diff for the session workspace. Never rejects for a busy session: a session-mode diff that cannot read the session’s file-change captures falls back to an unstaged git diff with isFallback: true and reports why in unavailableReason.

Wire method: session.workspaces.diff.

§Parameters
  • params - Parameters for computing a workspace diff.
§Returns

Workspace diff result for the requested mode.

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 SessionRpcWorkspaces<'a>

Source§

fn clone(&self) -> SessionRpcWorkspaces<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SessionRpcWorkspaces<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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