Skip to main content

CtlClient

Struct CtlClient 

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

Scoped client for ctl operations (transport-agnostic).

Implementations§

Source§

impl CtlClient

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

Parse a scoped response from raw bytes.

Source

pub async fn status(&self) -> Result<FileStatus>

Git status of this file. Requires a walked (not opened) fid.

Scope: query

Source

pub async fn log(&self, __request: &CtlLogRequest) -> Result<Vec<LogEntry>>

Commits touching this file. Requires a walked (not opened) fid.

Scope: query

Source

pub async fn diff(&self, __request: &CtlDiffRequest) -> Result<String>

Diff this file against a ref. Requires a walked (not opened) fid.

Scope: query

Source

pub async fn blame(&self) -> Result<String>

Git blame for this file. Requires a walked (not opened) fid.

Scope: query

Source

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

Restore file content from a ref

Scope: write

Source

pub async fn validate(&self) -> Result<ValidationResult>

Validate file format. Requires a walked (not opened) fid.

Scope: query

Source

pub async fn info(&self) -> Result<FileInfo>

File metadata and git state. Requires a walked (not opened) fid.

Scope: query

Source

pub async fn edit_open(&self, __request: &EditOpenRequest) -> Result<()>

Open file for CRDT editing

Scope: write

Source

pub async fn edit_state(&self) -> Result<String>

Get current CRDT document state

Scope: query

Source

pub async fn edit_apply(&self, __request: &EditApplyRequest) -> Result<()>

Apply automerge CRDT change

Scope: write

Source

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

Close CRDT editing session

Scope: write

Source

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

Write CRDT state to disk file

Scope: write

Source§

impl CtlClient

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 CtlClient

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 CtlClient

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 CtlClient

Source§

fn clone(&self) -> CtlClient

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 CtlRpc for CtlClient

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn ctl_flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: '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,