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
perspective-rsfor the Rust Client and Server APIs.perspective-jsfor the JavaScript API.perspective-pythonfor the Python API.perspective-serverfor Data Binding details.perspective-viewerfor the WebAssembly<perspective-viewer>Custom Element API.
Modules§
- config
- Options for
Table::view, and details about fields likeexpressions. - utils
- Utility functions that are common to the
perspectivecrates.
Structs§
- Client
- An instance of a
Clientis a connection to a singleperspective_server::Server, whether locally in-memory or remote over some transport like a WebSocket. - Column
Window - Delete
Options - Options for
Table::delete. - Expr
Validation Result - 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
Serverto which thisClientconnects. - OnUpdate
Data - Rows updated and port ID corresponding to an update batch, provided to the
callback argument to
View::on_updatewith the “rows” mode. - OnUpdate
Options - Options for
View::on_update. - Proxy
Session - A
Sessionimplementation which tunnels through anotherClient. @private - Reconnect
Callback - The type of the
reconnectparameter passed to [Client::handle_error}, and to the callback closure ofClient::on_error. - System
Info - Metadata about the engine runtime (such as total heap utilization).
- Table
Tableis Perspective’s columnar data frame, analogous to a Pandas/PolarsDataFrameor Apache Arrow, supporting append & in-place updates, removal by index, and update notifications.- Table
Init Options - Options which impact the behavior of
Client::table, as well as subsequent calls toTable::update. - Update
Options - Options for
Table::update. - View
- The
Viewstruct is Perspective’s query and serialization interface. It represents a query on theTable’s dataset and is always created from an existingTableinstance via theTable::viewmethod. - View
Window - Options for serializing a window of data from a
View.
Enums§
- OnUpdate
Mode - The update mode for
View::on_update. - Table
Data - The possible formats of input data which
Client::tablemay take as an argument. - Table
Read Format - The format to interpret data preovided to
Client::table. - Update
Data - The possible formats of input data which
Table::updatemay take as an argument.
Traits§
- Client
Handler - The client-side representation of a connection to a
Server. - Session
- The server-side representation of a connection to a
Client.