Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Appwrite client for making API requests

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Create a new Appwrite client

Source

pub fn set_endpoint<S: Into<String>>(&self, endpoint: S) -> Self

Set the API endpoint

Source

pub fn set_project<S: Into<String>>(&self, project: S) -> Self

Set the project ID

Source

pub fn set_key<S: Into<String>>(&self, key: S) -> Self

Set the API key

Source

pub fn set_jwt<S: Into<String>>(&self, jwt: S) -> Self

Set the JWT token

Source

pub fn set_locale<S: Into<String>>(&self, locale: S) -> Self

Set the locale

Source

pub fn set_session<S: Into<String>>(&self, session: S) -> Self

Set the session

Source

pub fn set_self_signed(&self, self_signed: bool) -> Self

Enable or disable self-signed certificates

Source

pub fn set_chunk_size(&self, chunk_size: usize) -> Self

Set chunk size for file uploads (minimum 1 byte)

Source

pub fn set_timeout(&self, timeout_secs: u64) -> Self

Set request timeout in seconds

Source

pub fn add_header<K: AsRef<str>, V: AsRef<str>>(&self, key: K, value: V) -> Self

Add a custom header

Source

pub fn get_headers(&self) -> HashMap<String, String>

Get a copy of the current request headers

Source

pub fn endpoint(&self) -> String

Get the current endpoint

Source

pub async fn call<T: DeserializeOwned>( &self, method: Method, path: &str, headers: Option<HashMap<String, String>>, params: Option<HashMap<String, Value>>, ) -> Result<T>

Source

pub async fn call_location( &self, method: Method, path: &str, headers: Option<HashMap<String, String>>, params: Option<HashMap<String, Value>>, ) -> Result<String>

Make an API call that returns a location/redirect URL (for webAuth endpoints)

Source

pub async fn call_bytes( &self, method: Method, path: &str, headers: Option<HashMap<String, String>>, params: Option<HashMap<String, Value>>, ) -> Result<Vec<u8>>

Make an API call that returns raw bytes (for downloads/location endpoints)

Source

pub async fn file_upload<T: DeserializeOwned>( &self, path: &str, headers: Option<HashMap<String, String>>, params: HashMap<String, Value>, param_name: &str, input_file: InputFile, upload_id: Option<String>, ) -> Result<T>

Upload a file

Source

pub async fn file_upload_with_progress<T: DeserializeOwned, F>( &self, path: &str, headers: Option<HashMap<String, String>>, params: HashMap<String, Value>, param_name: &str, input_file: InputFile, options: UploadOptions<F>, ) -> Result<T>
where F: Fn(UploadProgress),

Upload a file with progress callback

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more