pub struct Client(/* private fields */);
Expand description
An instance of a Client
is a connection to a single [Server
], whether
locally in-memory or remote over some transport like a WebSocket.
Client
and Perspective objects derived from it have synchronous APIs,
suitable for use in a repl or script context where this is the only
Client
connected to its [Server
]. If you want to
integrate with a Web framework or otherwise connect multiple clients,
use [AsyncClient
].
Implementations§
Source§impl Client
impl Client
pub fn new( handle_request: Py<PyAny>, close_cb: Option<Py<PyAny>>, name: Option<String>, ) -> PyResult<Self>
Sourcepub fn from_server(py: Python<'_>, server: Py<Server>) -> PyResult<Self>
pub fn from_server(py: Python<'_>, server: Py<Server>) -> PyResult<Self>
Create a new Client
instance bound to a specific in-process
[Server
] (e.g. generally not the global [Server
]).
Sourcepub fn handle_response(
&self,
py: Python<'_>,
response: Py<PyBytes>,
) -> PyResult<bool>
pub fn handle_response( &self, py: Python<'_>, response: Py<PyBytes>, ) -> PyResult<bool>
Handle a message from the external message queue.
Client::handle_response
is part of the low-level message-handling
API necessary to implement new transports for a Client
connection to a local-or-remote [Server
], and
doesn’t generally need to be called directly by “users” of a
Client
once connected.
Sourcepub fn table(
&self,
py: Python<'_>,
input: Py<PyAny>,
limit: Option<u32>,
index: Option<Py<PyString>>,
name: Option<Py<PyString>>,
format: Option<Py<PyString>>,
) -> PyResult<Table>
pub fn table( &self, py: Python<'_>, input: Py<PyAny>, limit: Option<u32>, index: Option<Py<PyString>>, name: Option<Py<PyString>>, format: Option<Py<PyString>>, ) -> PyResult<Table>
Creates a new Table
from either a schema or data.
The Client::table
factory function can be initialized with either a
schema (see Table::schema
), or data in one of these formats:
- Apache Arrow
- CSV
- JSON row-oriented
- JSON column-oriented
- NDJSON
When instantiated with data, the schema is inferred from this data.
While this is convenient, inferrence is sometimes imperfect e.g.
when the input is empty, null or ambiguous. For these cases,
Client::table
can first be instantiated with a explicit schema.
When instantiated with a schema, the resulting Table
is empty but
with known column names and column types. When subsqeuently
populated with Table::update
, these columns will be coerced to
the schema’s type. This behavior can be useful when
Client::table
’s column type inferences doesn’t work.
The resulting Table
is virtual, and invoking its methods
dispatches events to the perspective_server::Server
this
Client
connects to, where the data is stored and all calculation
occurs.
§Arguments
arg
- Either schema or initialization data.options
- Optional configuration which provides one of:limit
- The max number of rows the resultingTable
can store.index
- The column name to use as an index column. If thisTable
is being instantiated by data, this column name must be present in the data.name
- The name of the table. This will be generated if it is not provided.format
- The explicit format of the input data, can be one of"json"
,"columns"
,"csv"
or"arrow"
. This overrides language-specific type dispatch behavior, which allows stringified and byte array alternative inputs.
§Python Examples
Load a CSV from a str
:
table = client.table("x,y\n1,2\n3,4")
Sourcepub fn open_table(&self, py: Python<'_>, name: String) -> PyResult<Table>
pub fn open_table(&self, py: Python<'_>, name: String) -> PyResult<Table>
Opens a Table
that is hosted on the perspective_server::Server
that is connected to this Client
.
The name
property of TableInitOptions
is used to identify each
Table
. Table
name
s can be looked up for each Client
via Client::get_hosted_table_names
.
§Python Examples
table = client.open_table("table_one");
Sourcepub fn get_hosted_table_names(&self, py: Python<'_>) -> PyResult<Vec<String>>
pub fn get_hosted_table_names(&self, py: Python<'_>) -> PyResult<Vec<String>>
Retrieves the names of all tables that this client has access to.
name
is a string identifier unique to the Table
(per Client
),
which can be used in conjunction with Client::open_table
to get
a Table
instance without the use of Client::table
constructor directly (e.g., one created by another Client
).
§Python Examples
tables = client.get_hosted_table_names();
Sourcepub fn on_hosted_tables_update(
&self,
py: Python<'_>,
callback: Py<PyAny>,
) -> PyResult<u32>
pub fn on_hosted_tables_update( &self, py: Python<'_>, callback: Py<PyAny>, ) -> PyResult<u32>
Register a callback which is invoked whenever Client::table
(on this
Client
) or Table::delete
(on a Table
belinging to this
Client
) are called.
Sourcepub fn remove_hosted_tables_update(
&self,
py: Python<'_>,
callback_id: u32,
) -> PyResult<()>
pub fn remove_hosted_tables_update( &self, py: Python<'_>, callback_id: u32, ) -> PyResult<()>
Remove a callback previously registered via
Client::on_hosted_tables_update
.
Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for Client
impl<'py> IntoPyObject<'py> for Client
Source§type Output = Bound<'py, <Client as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <Client as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClassBaseType for Client
impl PyClassBaseType for Client
type LayoutAsBase = PyClassObject<Client>
type BaseNativeType = <Client as PyClassImpl>::BaseNativeType
type Initializer = PyClassInitializer<Client>
type PyClassMutability = <Client as PyClassImpl>::PyClassMutability
Source§impl PyClassImpl for Client
impl PyClassImpl for Client
Source§const IS_BASETYPE: bool = true
const IS_BASETYPE: bool = true
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§type ThreadChecker = SendablePyClass<Client>
type ThreadChecker = SendablePyClass<Client>
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
PyAny
by default, and when you declare
#[pyclass(extends=PyDict)]
, it’s PyDict
.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
fn dict_offset() -> Option<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature<Client> for PyClassImplCollector<Client>
impl PyClassNewTextSignature<Client> for PyClassImplCollector<Client>
fn new_text_signature(self) -> Option<&'static str>
Source§impl PyMethods<Client> for PyClassImplCollector<Client>
impl PyMethods<Client> for PyClassImplCollector<Client>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for Client
impl PyTypeInfo for Client
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
impl DerefToPyAny for Client
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self
into an owned Python object, dropping type information.