Struct VoltClient

pub struct VoltClient { /* private fields */ }

The VoltClient struct is the main entry point for interacting with the Volt API. It provides methods for making unary, server streaming, and client streaming RPC calls. The client maintains a connection to the Volt server and handles the WebSocket communication, it manages the RPC lifecycle, including sending requests and receiving responses. The client also provides a set of convenience methods for making calls to the Volt API.

Implementations

impl VoltClient

pub async fn create(config_json: &str) -> Result<VoltClient, String>

Creates a new API client instance and connects to the WebSocket server. The client is configured with the provided JSON configuration.

Arguments

• config_json - A JSON string containing the configuration settings.

Returns

A Result containing the API client instance or an error message.

pub async fn unary_rpc( &mut self, method: &str, request: &Value, service: &str, ) -> Result<Value, String>

Generic method for unary RPC calls. Sends a request and awaits the response.

Arguments

• method - The method to call.
• request - The request payload.
• service - The service to call.

Returns

A Result containing the response or an error message.

pub async fn server_streaming_call( &mut self, method: &str, request: &Value, service: &str, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

Generic method for server streaming RPC calls. Sends a request and returns an RPC instance.

Arguments

• method - The method to call.
• request - The request payload.
• service - The service to call.

Returns

A Result containing the RPC event emitter or an error message.

pub async fn streaming_call( &mut self, method: &str, request: &Value, service: &str, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

Generic method for client streaming RPC calls. Sends a request and returns an RPC instance.

Arguments

• method - The method to call.
• request - The request payload.
• service - The service to call.

Returns

A Result containing the RPC event emitter or an error message.

pub async fn can_access_resource( &mut self, request: &Value, ) -> Result<Value, String>

RESOURCE API

See https://docs.tdxvolt.com/en/api/volt_api#CanAccessResource

pub async fn connect( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/volt_api#Connect

pub async fn delete_resource( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#DeleteResource

pub async fn discover_services( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#DiscoverServices

pub async fn get_resource(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetResource

pub async fn get_resources(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetResources

pub async fn get_resource_ancestors( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetResourceAncestors

pub async fn get_resource_descendants( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetResourceDescendants

pub async fn request_access(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#RequestAccess

pub async fn save_resource(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SaveResource

pub async fn save_resource_attribute( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SaveResourceAttribute

pub async fn set_service_status( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SetServiceStatus

pub async fn download_file( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

FILE API

See https://docs.tdxvolt.com/en/api/file_api#DownloadFile

pub async fn get_file(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/file_api#GetFile

pub async fn get_file_content( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/file_api#GetFileContent

pub async fn get_file_descendants( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/file_api#GetFileDescendants

pub async fn set_file_content( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/file_api#SetFileContent

pub async fn upload_file( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/file_api#UploadFile

pub async fn authenticate(&mut self, request: &Value) -> Result<Value, String>

VOLT MANAGEMENT API

See https://docs.tdxvolt.com/en/api/volt_api#Authenticate

pub async fn delete_access(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#DeleteAccess

pub async fn delete_volt(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#DeleteVolt

pub async fn get_access(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetAccess

pub async fn get_identities(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetIdentities

pub async fn get_identity(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetIdentity

pub async fn get_one_time_token( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetOneTimeToken

pub async fn get_policy(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetPolicy

pub async fn get_settings(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#GetSettings

pub async fn invoke(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#Invoke

pub async fn save_access(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SaveAccess

pub async fn save_identity(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SaveIdentity

pub async fn save_settings(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SaveSettings

pub async fn set_access_request_decision( &mut self, request: &Value, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SetAccessRequestDecision

pub async fn sign_verify(&mut self, request: &Value) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/volt_api#SignVerify

pub async fn publish_wire( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

WIRE API

See https://docs.tdxvolt.com/en/api/wire_api#PublishWire

pub async fn subscribe_wire( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/wire_api#SubscribeWire

pub async fn bulk_update( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

DATABASE API

See https://docs.tdxvolt.com/en/api/sqlite_database_api#BulkUpdate

pub async fn create_database( &mut self, request: &Value, ) -> Result<Value, String>

https://docs.tdxvolt.com/en/api/sqlite_server_api#CreateDatabase

pub async fn sql_execute( &mut self, request: &Value, service: &str, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/sqlite_database_api#Execute

pub async fn sql_execute_json( &mut self, request: &Value, service: &str, ) -> Result<Value, String>

See https://docs.tdxvolt.com/en/api/sqlite_database_api#Execute

pub async fn import_csv( &mut self, request: &Value, ) -> Result<Arc<Mutex<WebsocketRpc>>, String>

See https://docs.tdxvolt.com/en/api/sqlite_database_api#ImportCSV