Struct RouteChannelEngine 

pub struct RouteChannelEngine { /* private fields */ }

A SurrealEngine that drives an engine which consumes Routes.

The WebSocket and HTTP engines each run a task that reads Routes off a channel and answers on the response channel a Route carries – the channel is also their session replay log, so a reconnection can rebuild what the connection had established. This adapter is the whole of what it takes to expose one of them through SurrealEngine: it turns each typed call back into the Command that task already understands, and unwraps the single response into the type the method promises.

Command is therefore an implementation detail of those two engines, not part of the interface: an engine with no route channel – the embedded and gRPC ones – never constructs a Command at all.

Implementations

impl RouteChannelEngine

pub fn new(sender: Sender<Route>) -> Self

Wraps a route sender as a SurrealEngine.

Trait Implementations

impl Clone for RouteChannelEngine

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteChannelEngine

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SurrealEngine for RouteChannelEngine

fn query( &self, ctx: EngineContext, query: Cow<'static, str>, variables: Variables, ) -> EngineFuture<'_, Vec<QueryResult>>

Executes SurrealQL, returning one result per statement, in order.

fn run( &self, ctx: EngineContext, name: String, version: Option<String>, args: Array, ) -> EngineFuture<'_, Value>

Calls a function, or a machine learning model when version is set.

fn use_ns_db( &self, ctx: EngineContext, namespace: Option<String>, database: Option<String>, ) -> EngineFuture<'_, (Option<String>, Option<String>)>

Selects the namespace and/or database, returning the resulting selection. None for either argument leaves that one unchanged.

fn set( &self, ctx: EngineContext, key: String, value: Value, ) -> EngineFuture<'_, ()>

Binds a session variable.

fn unset(&self, ctx: EngineContext, key: String) -> EngineFuture<'_, ()>

Removes a session variable.

fn signup( &self, ctx: EngineContext, credentials: Object, ) -> EngineFuture<'_, Token>

Registers a record user and authenticates the session as them.

fn signin( &self, ctx: EngineContext, credentials: Object, ) -> EngineFuture<'_, Token>

Authenticates the session with credentials.

fn authenticate( &self, ctx: EngineContext, token: Token, ) -> EngineFuture<'_, Token>

Authenticates the session with an existing token, returning the token now in effect.

fn refresh(&self, ctx: EngineContext, token: Token) -> EngineFuture<'_, Token>

Exchanges a refresh token for a fresh token pair.

fn revoke(&self, ctx: EngineContext, token: Token) -> EngineFuture<'_, ()>

Invalidates a refresh token so it can no longer be redeemed.

fn invalidate(&self, ctx: EngineContext) -> EngineFuture<'_, ()>

Drops the session’s authentication.

fn begin(&self, ctx: EngineContext) -> EngineFuture<'_, Uuid>

Opens an explicit transaction, returning its id.

fn commit(&self, ctx: EngineContext, txn: Uuid) -> EngineFuture<'_, ()>

Commits an explicit transaction.

fn rollback(&self, ctx: EngineContext, txn: Uuid) -> EngineFuture<'_, ()>

Cancels an explicit transaction.

fn health(&self, ctx: EngineContext) -> EngineFuture<'_, ()>

Checks that the engine is reachable.

fn version(&self, ctx: EngineContext) -> EngineFuture<'_, String>

Reports the database version, as the server spells it (for example surrealdb-3.0.0).

fn subscribe_live( &self, ctx: EngineContext, uuid: Uuid, notifications: Sender<Result<Notification, Error>>, ) -> EngineFuture<'_, ()>

Registers the channel a live query’s notifications are delivered on.

fn kill(&self, ctx: EngineContext, uuid: Uuid) -> EngineFuture<'_, ()>

Kills a live query.

fn export_file( &self, ctx: EngineContext, path: PathBuf, config: Option<DbExportConfig>, ) -> EngineFuture<'_, ()>

Exports the database to a file.

fn export_bytes( &self, ctx: EngineContext, bytes: Sender<Result<Vec<u8>, Error>>, config: Option<DbExportConfig>, ) -> EngineFuture<'_, ()>

Exports the database, streaming it to a channel.

fn export_ml_file( &self, ctx: EngineContext, path: PathBuf, config: MlExportConfig, ) -> EngineFuture<'_, ()>

Exports a machine learning model to a file.

fn export_ml_bytes( &self, ctx: EngineContext, bytes: Sender<Result<Vec<u8>, Error>>, config: MlExportConfig, ) -> EngineFuture<'_, ()>

Exports a machine learning model, streaming it to a channel.

fn import_file(&self, ctx: EngineContext, path: PathBuf) -> EngineFuture<'_, ()>

Imports a database export from a file.

fn import_ml_file( &self, ctx: EngineContext, path: PathBuf, ) -> EngineFuture<'_, ()>

Imports a machine learning model from a file.

fn query_stream( &self, ctx: EngineContext, query: Cow<'static, str>, variables: Variables, items: Sender<QueryStreamItem>, ) -> EngineFuture<'_, ()>

Executes SurrealQL, sending results into items as they are produced.