Struct Client

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn set_token<S: Into<String>>(&mut self, token: S)

pub fn get_token(&self) -> &str

pub async fn new_with_oauth2_token<S: Into<String>, T: Into<String>, U: Into<String>>( protocol: Protocol, host: S, port: T, token: U, timeout_and_retries: Option<TimeoutAndRetries>, ) -> Result<Self, HstpError>

pub async fn get_user_id(&mut self) -> Result<String, HstpError>

pub async fn query_for_entity_array<S: Into<String>>( &mut self, query: S, ) -> Result<QueryEntitiesReturn, HstpError>

pub async fn query_for_entity<S: Into<String>>( &mut self, query: S, ) -> Result<HSMLEntity, HstpError>

pub async fn query_for_value_array<S: Into<String>>( &mut self, query: S, ) -> Result<Vec<Value>, HstpError>

pub async fn query_for_value<S: Into<String>>( &mut self, query: S, ) -> Result<Value, HstpError>

pub async fn query<S: Into<String>>( &mut self, query: S, ) -> Result<Value, HstpError>

pub async fn upsert<V: AsRef<[HSMLEntity]>>( &mut self, entities: V, collision_strategy: CollisionStrategy, ) -> Result<Vec<HSMLEntity>, HstpError>

pub async fn upsert_one( &mut self, entity: &HSMLEntity, collision_strategy: CollisionStrategy, ) -> Result<HSMLEntity, HstpError>

pub async fn upsert_hsml_json<P: AsRef<Path>>( &mut self, path: P, collision_strategy: CollisionStrategy, ) -> Result<Vec<HSMLEntity>, HstpError>

pub async fn create_listener(&mut self) -> Result<Listener, HstpError>

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for Client

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for Client

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Client

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Client>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Client

type Holder = Option<PyRef<'py, Client>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Client

type Holder = Option<PyRefMut<'py, Client>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyTypeInfo for Client

const NAME: &'static str = "Client"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<Client>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.