Crate perspective_client

Crate perspective_client 

Source
Expand description

perspective_client is the client implementation of Perspective, designed to be used from Rust directly, and as a core to perspective-js and perspective-python crates which wrap language-specific bindings for this module.

§See also

Modules§

config
Options for Table::view, and details about fields like expressions.
utils
Utility functions that are common to the perspective crates.

Structs§

Client
An instance of a Client is a connection to a single perspective_server::Server, whether locally in-memory or remote over some transport like a WebSocket.
ColumnWindow
DeleteOptions
Options for Table::delete.
ExprValidationResult
Result of a call to Table::validate_expressions, containing a schema for valid expressions and error messages for invalid ones.
Features
Metadata about what features are supported by the Server to which this Client connects.
OnUpdateData
Rows updated and port ID corresponding to an update batch, provided to the callback argument to View::on_update with the “rows” mode.
OnUpdateOptions
Options for View::on_update.
ProxySession
A Session implementation which tunnels through another Client. @private
ReconnectCallback
The type of the reconnect parameter passed to [Client::handle_error}, and to the callback closure of Client::on_error.
SystemInfo
Metadata about the engine runtime (such as total heap utilization).
Table
Table is Perspective’s columnar data frame, analogous to a Pandas/Polars DataFrame or Apache Arrow, supporting append & in-place updates, removal by index, and update notifications.
TableInitOptions
Options which impact the behavior of Client::table, as well as subsequent calls to Table::update.
UpdateOptions
Options for Table::update.
View
The View struct is Perspective’s query and serialization interface. It represents a query on the Table’s dataset and is always created from an existing Table instance via the Table::view method.
ViewWindow
Options for serializing a window of data from a View.

Enums§

OnUpdateMode
The update mode for View::on_update.
TableData
The possible formats of input data which Client::table may take as an argument.
TableReadFormat
The format to interpret data preovided to Client::table.
UpdateData
The possible formats of input data which Table::update may take as an argument.

Traits§

ClientHandler
The client-side representation of a connection to a Server.
Session
The server-side representation of a connection to a Client.

Type Aliases§

ClientError
ExprValidationError