Skip to main content

WorktreeClient

Struct WorktreeClient 

Source
pub struct WorktreeClient { /* private fields */ }
Expand description

Scoped client for worktree operations (transport-agnostic).

Implementations§

Source§

impl WorktreeClient

Source

pub fn next_id(&self) -> u64

Get the next request ID.

Source

pub async fn call(&self, payload: Vec<u8>) -> Result<Vec<u8>>

Send a raw request and return the raw response bytes.

Source

pub async fn call_streaming( &self, payload: Vec<u8>, ephemeral_pubkey: [u8; 32], ) -> Result<Vec<u8>>

Send a streaming request with ephemeral DH pubkey.

Source

pub fn parse_scoped_response( bytes: &[u8], ) -> Result<WorktreeClientResponseVariant>

Parse a scoped response from raw bytes.

Source

pub async fn walk(&self, __request: &NpWalk) -> Result<RWalk>

Resolve path components to a fid (9P walk). Use the returned fid for open (I/O) or ctl operations (git log/diff/blame). Each use requires a separate fid.

Scope: query

Source

pub async fn open(&self, __request: &NpOpen) -> Result<ROpen>

Open a walked fid for read/write I/O. After open, the fid can only be used for read/write — ctl operations (log, diff, blame) require a separate walked-not-opened fid.

Scope: write

Source

pub async fn create(&self, __request: &NpCreate) -> Result<ROpen>

Create a file or directory under a walked directory fid. The fid is then opened for I/O on the new file.

Scope: write

Source

pub async fn read(&self, __request: &NpRead) -> Result<RRead>

Read file content or directory listing at offset+count (bounded by iounit). For directories, returns entries as binary: name_len(u32) + name + is_dir(u8) + size(u64).

Scope: query

Source

pub async fn write(&self, __request: &NpWrite) -> Result<RWrite>

Write data to an opened file at offset. Data size must not exceed iounit.

Scope: write

Source

pub async fn clunk(&self, __request: &NpClunk) -> Result<()>

Release a fid (like close). Frees server resources. Always clunk fids when done.

Scope: query

Source

pub async fn remove(&self, __request: &NpRemove) -> Result<()>

Remove a file or directory and release its fid.

Scope: manage

Source

pub async fn np_stat(&self, __request: &NpStatReq) -> Result<RStat>

Get file metadata (size, mode, timestamps). Works on both walked and opened fids.

Scope: query

Source

pub async fn wstat(&self, __request: &NpWstat) -> Result<()>

Modify file metadata (truncate, rename). Requires an opened fid for truncate.

Scope: write

Source

pub async fn flush(&self, __request: &NpFlush) -> Result<()>

Cancel a pending operation by its tag.

Scope: query

Source

pub async fn stage_all(&self) -> Result<()>

Stage all modified tracked files in this worktree

Scope: write

Source

pub async fn stage_files(&self, __request: &StageFilesRequest) -> Result<()>

Stage specific files in this worktree

Scope: write

Source

pub async fn stage_all_including_untracked(&self) -> Result<()>

Stage all files including untracked in this worktree

Scope: write

Source

pub async fn commit(&self, __request: &CommitRequest) -> Result<String>

Commit staged changes in this worktree

Scope: write

Source

pub async fn commit_with_author( &self, __request: &CommitWithAuthorRequest, ) -> Result<String>

Commit staged changes with specified author

Scope: write

Source

pub async fn amend_commit( &self, __request: &AmendCommitRequest, ) -> Result<String>

Amend the last commit in this worktree

Scope: write

Source

pub async fn checkout(&self, __request: &CheckoutRequest) -> Result<()>

Checkout a ref in this worktree

Scope: write

Source

pub async fn merge(&self, __request: &MergeRequest) -> Result<()>

Merge a branch into this worktree

Scope: write

Source

pub async fn abort_merge(&self) -> Result<()>

Abort an in-progress merge in this worktree

Scope: write

Source

pub async fn continue_merge( &self, __request: &ContinueMergeRequest, ) -> Result<()>

Continue a merge after resolving conflicts

Scope: write

Source

pub async fn quit_merge(&self) -> Result<()>

Exit merge state without committing

Scope: write

Source

pub async fn open_read(&self, __request: &NpStatReq) -> Result<ROpen>

Open a walked fid for read-only I/O.

Scope: query

Source

pub fn ctl(&self, fid: u32) -> CtlClient

Create a scoped ctl client.

Source§

impl WorktreeClient

Source

pub async fn call_method(&self, method: &str, args: &Value) -> Result<Value>

Dispatch a scoped method call by name with JSON arguments.

Source

pub async fn call_streaming_method( &self, method: &str, args: &Value, ephemeral_pubkey: [u8; 32], ) -> Result<StreamInfo>

Dispatch a scoped streaming method call by name with JSON arguments and an ephemeral public key. Returns the verified-capnp StreamInfo library type (#468).

Source§

impl WorktreeClient

Source

pub async fn call_scoped_method( &self, scopes: &[(&str, &str)], method: &str, args: &Value, ) -> Result<Value>

Dispatch a scoped method call through nested scope chain.

Source§

impl WorktreeClient

Source

pub async fn call_scoped_streaming_method( &self, scopes: &[(&str, &str)], method: &str, args: &Value, ephemeral_pubkey: [u8; 32], ) -> Result<StreamInfo>

Dispatch a scoped streaming method call through nested scope chain.

Trait Implementations§

Source§

impl Clone for WorktreeClient

Source§

fn clone(&self) -> WorktreeClient

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 WorktreeRpc for WorktreeClient

Source§

type Ctl = CtlClient

Source§

fn ctl(&self, fid: u32) -> Self::Ctl

Source§

fn walk<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpWalk, ) -> Pin<Box<dyn Future<Output = Result<RWalk>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn open<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpOpen, ) -> Pin<Box<dyn Future<Output = Result<ROpen>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn create<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpCreate, ) -> Pin<Box<dyn Future<Output = Result<ROpen>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn read<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpRead, ) -> Pin<Box<dyn Future<Output = Result<RRead>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn write<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpWrite, ) -> Pin<Box<dyn Future<Output = Result<RWrite>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn clunk<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpClunk, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpRemove, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn np_stat<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpStatReq, ) -> Pin<Box<dyn Future<Output = Result<RStat>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn wstat<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpWstat, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn flush<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpFlush, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn stage_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn stage_files<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 StageFilesRequest, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn stage_all_including_untracked<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn commit<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 CommitRequest, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn commit_with_author<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 CommitWithAuthorRequest, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn amend_commit<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 AmendCommitRequest, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn checkout<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 CheckoutRequest, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn merge<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MergeRequest, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn abort_merge<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn continue_merge<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 ContinueMergeRequest, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn quit_merge<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn open_read<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 NpStatReq, ) -> Pin<Box<dyn Future<Output = Result<ROpen>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> TerminalState for T
where T: Clone + Send + Sync,