Skip to main content

Client

Struct Client 

Source
pub struct Client {
    pub base: Url,
    /* private fields */
}

Fields§

§base: Url

Implementations§

Source§

impl Client

Source

pub fn new(settings: &Settings) -> Result<Client>

Source

pub fn key(&self) -> &str

Source

pub fn origin(&self) -> String

Source

pub fn url(&self, path: &str) -> Url

Source

pub async fn whoami(&self) -> Result<WhoAmI>

Source

pub async fn push( &self, id: Option<&str>, body: Vec<u8>, content_type: &str, q: &PushQuery, if_match: Option<i64>, ) -> Result<PushResponse>

if_match: refuse (412, exit 5) unless the document is at this revision.

Source

pub async fn doc(&self, id: &str) -> Result<DocDetail>

Source

pub async fn list(&self, q: &ListQuery) -> Result<ListResponse>

Source

pub async fn project_docs(&self, project: &str) -> Result<Vec<DocSummary>>

Every live document of a project, page by page. Sorted by creation, which a push doesn’t change, so no document moves between pages while they are read.

Source

pub async fn raw( &self, id: &str, path: Option<&str>, rev: Option<i64>, ) -> Result<Vec<u8>>

Source

pub async fn patch(&self, id: &str, p: &PatchDoc) -> Result<DocSummary>

Source

pub async fn delete(&self, id: &str) -> Result<()>

Source

pub async fn say( &self, id: &str, text: &str, reply_to: Option<i64>, ) -> Result<SayOut>

Source

pub async fn events( &self, id: &str, after: Option<i64>, wait: u64, kinds: Option<&str>, ) -> Result<EventsResponse>

Source

pub async fn download(&self, url: &str) -> Result<Vec<u8>>

Source

pub async fn keys(&self) -> Result<Vec<KeyInfo>>

Source

pub async fn create_key(&self, req: &CreateKeyRequest) -> Result<CreatedKey>

Source

pub async fn doc_at(&self, project: &str, path: &str) -> Result<DocSummary>

The document a project path means (exact path, or the bundle that holds it).

Source

pub async fn projects(&self) -> Result<Vec<ProjectInfo>>

Source

pub async fn create_project( &self, req: &CreateProject, ) -> Result<ProjectCreated>

Source

pub async fn mappings(&self, slug: &str) -> Result<MappingList>

Source

pub async fn set_mappings( &self, slug: &str, list: &[Mapping], ) -> Result<MappingList>

Source

pub async fn revoke_key(&self, id: i64) -> Result<()>

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

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

Auto Trait Implementations§

§

impl !RefUnwindSafe for Client

§

impl !UnwindSafe for Client

§

impl Forget for Client

§

impl Freeze for Client

§

impl Move for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnsafeUnpin for Client

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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