Struct Server 

pub struct Server { /* private fields */ }

Implementations

impl Server

pub async fn bind(addr: impl ToSocketAddrs, data_dir: &Path) -> Result<Self>

Bind the server to addr with data sharded under data_dir.

The shard count equals the number of performance cores.

Errors

Returns an error if the address cannot be bound or a shard cannot start.

pub async fn bind_with_shards( addr: impl ToSocketAddrs, data_dir: &Path, n_shards: usize, workers: usize, ) -> Result<Self>

Bind the server with an explicit shard count and worker-pool size.

workers == 0 (default) keeps VSEARCH inline on the shard thread (Personal AI default). workers > 0 dispatches VSEARCH to a tokio blocking pool so KV ops do not queue behind multi-ms vector searches (multi-tenant pattern, opt-in via --workers N on the CLI).

Errors

Returns an error if the address cannot be bound or a shard cannot start.

pub async fn bind_full( addr: impl ToSocketAddrs, data_dir: &Path, n_shards: usize, workers: usize, mmap_tier: bool, ) -> Result<Self>

Full-knob constructor for the read-write path: shard count, worker pool, and the opt-in mmap_tier flag (see --tier-mmap in the server CLI). Other entry points delegate here with defaults.

Errors

Returns an error if the address cannot be bound or a shard cannot start.

pub async fn bind_full_mmap( addr: impl ToSocketAddrs, data_dir: &Path, n_shards: usize, workers: usize, mmap_tier: bool, mmap_graph: bool, ) -> Result<Self>

All-knobs constructor for the read-write path. Adds mmap_graph to bind_full.

Errors

Returns an error if the address cannot be bound or a shard cannot start.

pub fn with_tenant_backend(self, backend: Arc<dyn TenantBackend>) -> Self

Install a multi-tenant backend on a server already built by one of the bind* constructors. Builder-style for clarity at the call site. When set, the RESP3 handler honours HELLO 3 AUTH and scopes KV / vector ops by tenant id.

pub async fn bind_serve( addr: impl ToSocketAddrs, data_dir: &Path, tier: QuantKind, workers: usize, ) -> Result<Self>

Bind the server in serve mode: a single shard over the offline-built index at data_dir, read-only. Every mutation (KV and vector) is rejected; the index is served at its clean resident footprint.

data_dir is a directory produced by skeg-tool build. tier is the tier-1 quantisation built for the served index: QuantKind::Int8 or QuantKind::Pq { m, k } (smaller footprint). workers > 0 enables the VSEARCH dispatch pool described in [bind_with_shards].

Errors

Returns an error if the address cannot be bound or the shard cannot start.

pub async fn bind_serve_full( addr: impl ToSocketAddrs, data_dir: &Path, tier: QuantKind, workers: usize, mmap_tier: bool, ) -> Result<Self>

Full-knob serve mode: like [bind_serve] plus the opt-in mmap_tier flag that swaps the TurboQuant codes for a memory-mapped view of tier.cache.bin at open.

Errors

Returns an error if the address cannot be bound or the shard cannot start.

pub async fn bind_serve_full_mmap( addr: impl ToSocketAddrs, data_dir: &Path, tier: QuantKind, workers: usize, mmap_tier: bool, mmap_graph: bool, ) -> Result<Self>

All-knobs serve mode. Adds mmap_graph to bind_serve_full.

Errors

Returns an error if the address cannot be bound or the shard cannot start.

pub fn local_addr(&self) -> Result<SocketAddr>

Return the local address the server is listening on.

Errors

Returns an error if the OS cannot retrieve the socket address.

pub fn n_shards(&self) -> usize

Number of shards backing this server.

pub async fn run(self) -> Result<()>

Accept connections and handle them until an I/O error on accept.

Errors

Returns the first error from TcpListener::accept.

pub async fn run_resp3(self) -> Result<()>

Like run, but speaks RESP3 (Redis wire) on the listener instead of the skeg binary protocol. Same shard set, same storage, different encoding.

Errors

Returns the first error from TcpListener::accept.