Struct DocxControlPlane 

pub struct DocxControlPlane<C: Connection> { /* private fields */ }

Facade for ingestion and query operations for a single solution store.

Implementations

impl<C: Connection> DocxControlPlane<C>

pub async fn ingest_csharp_xml( &self, request: CsharpIngestRequest, ) -> Result<CsharpIngestReport, ControlError>

Ingests C# XML documentation into the store.

Errors

Returns ControlError if validation fails, parsing fails, or store writes fail.

pub async fn ingest_rustdoc_json( &self, request: RustdocIngestRequest, ) -> Result<RustdocIngestReport, ControlError>

Ingests rustdoc JSON documentation into the store.

Errors

Returns ControlError if validation fails, parsing fails, or store writes fail.

impl<C: Connection> DocxControlPlane<C>

pub async fn upsert_project( &self, request: ProjectUpsertRequest, ) -> Result<Project, ControlError>

Upserts a project and merges aliases.

Errors

Returns ControlError if the input is invalid or the store operation fails.

pub async fn get_project( &self, project_id: &str, ) -> Result<Option<Project>, ControlError>

Fetches a project by id.

Errors

Returns ControlError if the store query fails.

pub async fn get_ingest( &self, ingest_id: &str, ) -> Result<Option<Ingest>, ControlError>

Fetches an ingest record by id.

Errors

Returns ControlError if the store query fails.

pub async fn get_doc_source( &self, doc_source_id: &str, ) -> Result<Option<DocSource>, ControlError>

Fetches a document source by id.

Errors

Returns ControlError if the store query fails.

pub async fn list_projects( &self, limit: usize, ) -> Result<Vec<Project>, ControlError>

Lists projects with an optional limit.

Errors

Returns ControlError if the store query fails.

pub async fn list_ingests( &self, project_id: &str, limit: usize, ) -> Result<Vec<Ingest>, ControlError>

Lists ingests for a project.

Errors

Returns ControlError if the store query fails.

pub async fn list_doc_sources( &self, project_id: &str, ingest_id: Option<&str>, limit: usize, ) -> Result<Vec<DocSource>, ControlError>

Lists document sources for a project, optionally filtered by ingest id.

Errors

Returns ControlError if the store query fails.

pub async fn search_projects( &self, pattern: &str, limit: usize, ) -> Result<Vec<Project>, ControlError>

Searches projects by a name or alias pattern.

Errors

Returns ControlError if the store query fails.

impl<C: Connection> DocxControlPlane<C>

pub async fn get_symbol( &self, project_id: &str, symbol_key: &str, ) -> Result<Option<Symbol>, ControlError>

Fetches a symbol by project and key.

Errors

Returns ControlError if the store query fails.

pub async fn list_doc_blocks( &self, project_id: &str, symbol_key: &str, ingest_id: Option<&str>, ) -> Result<Vec<DocBlock>, ControlError>

Lists document blocks for a symbol, optionally scoping by ingest id.

Errors

Returns ControlError if the store query fails.

pub async fn search_symbols( &self, project_id: &str, name: &str, limit: usize, ) -> Result<Vec<Symbol>, ControlError>

Searches symbols by name.

Errors

Returns ControlError if the store query fails.

pub async fn search_doc_blocks( &self, project_id: &str, text: &str, limit: usize, ) -> Result<Vec<DocBlock>, ControlError>

Searches document blocks by text.

Errors

Returns ControlError if the store query fails.

pub async fn list_symbol_kinds( &self, project_id: &str, ) -> Result<Vec<String>, ControlError>

Lists distinct symbol kinds for a project.

Errors

Returns ControlError if the store query fails.

pub async fn list_members_by_scope( &self, project_id: &str, scope: &str, limit: usize, ) -> Result<Vec<Symbol>, ControlError>

Lists members by scope prefix or glob pattern.

Errors

Returns ControlError if the store query fails.

pub async fn get_symbol_adjacency( &self, project_id: &str, symbol_key: &str, limit: usize, ) -> Result<SymbolAdjacency, ControlError>

Fetches adjacency information for a symbol, including relations and related symbols.

Errors

Returns ControlError if the store query fails.

impl<C: Connection> DocxControlPlane<C>

pub fn new(db: Surreal<C>) -> Self

Creates a control plane from a SurrealDB connection.

pub const fn from_arc(db: Arc<Surreal<C>>) -> Self

Creates a control plane from a shared SurrealDB connection.

pub const fn with_store(store: SurrealDocStore<C>) -> Self

Creates a control plane from an existing store implementation.

pub const fn store(&self) -> &SurrealDocStore<C>

Returns the underlying store implementation.

Trait Implementations

impl<C: Connection> Clone for DocxControlPlane<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.