Skip to main content

DocumentServiceWrapper

Struct DocumentServiceWrapper 

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

Thread-safe, Clone-able FFI wrapper for the unified Document API.

All methods accept JSON strings and return JSON strings, making them suitable for consumption from Python, Node.js, Go, and other FFI callers.

Implementations§

Source§

impl DocumentServiceWrapper

Source

pub fn new(service: Box<dyn DocumentService>) -> Self

Create a wrapper from a boxed DocumentService.

Source

pub fn from_arc(service: Arc<dyn DocumentService>) -> Self

Create a wrapper from an Arc<dyn DocumentService>.

Source

pub fn from_agent_wrapper(wrapper: &AgentWrapper) -> BindingResult<Self>

Create a wrapper from an AgentWrapper using the filesystem backend.

This is the typical construction path for language bindings: load an agent, then create a document service from it.

Source

pub fn create_json( &self, json: &str, options_json: Option<&str>, ) -> BindingResult<String>

Create a new document. Returns the signed document as JSON.

options_json is an optional JSON string of CreateOptions. If None, defaults are used.

Source

pub fn get_json(&self, key: &str) -> BindingResult<String>

Get a document by key (id:version). Returns the document JSON.

Source

pub fn get_latest_json(&self, document_id: &str) -> BindingResult<String>

Get the latest version of a document. Returns the document JSON.

Source

pub fn update_json( &self, document_id: &str, new_json: &str, options_json: Option<&str>, ) -> BindingResult<String>

Update a document, creating a new signed version. Returns the new version JSON.

options_json is an optional JSON string of UpdateOptions.

Source

pub fn remove_json(&self, key: &str) -> BindingResult<String>

Remove (tombstone) a document. Returns the tombstoned document JSON.

Source

pub fn list_json(&self, filter_json: Option<&str>) -> BindingResult<String>

List documents with optional filter. Returns JSON array of DocumentSummary.

filter_json is an optional JSON string of ListFilter.

Source

pub fn search_json(&self, query_json: &str) -> BindingResult<String>

Search documents. Returns JSON SearchResults.

query_json is a JSON string of SearchQuery.

Source

pub fn versions_json(&self, document_id: &str) -> BindingResult<String>

Get all versions of a document. Returns JSON array of documents.

Source

pub fn diff_json(&self, key_a: &str, key_b: &str) -> BindingResult<String>

Diff two document versions. Returns JSON DocumentDiff.

Source

pub fn visibility_json(&self, key: &str) -> BindingResult<String>

Get the visibility of a document. Returns JSON string ("public", "private", etc.).

Source

pub fn set_visibility_json( &self, key: &str, visibility_json: &str, ) -> BindingResult<()>

Set the visibility of a document.

visibility_json is a JSON string (e.g., "public", "private", {"restricted":["agent-a"]}).

Trait Implementations§

Source§

impl Clone for DocumentServiceWrapper

Source§

fn clone(&self) -> DocumentServiceWrapper

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

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> 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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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