Skip to main content

DavClient

Struct DavClient 

Source
pub struct DavClient<'a, T: Transport, A: AuthProvider> { /* private fields */ }
Expand description

WebDAV client generic over the transport and the credential source.

Both are held by reference, so a client can be borrowed into several spawned tasks and share one connection pool and one token.

Implementations§

Source§

impl<'a, T: Transport, A: AuthProvider> DavClient<'a, T, A>

Source

pub const fn new(transport: &'a T, auth: &'a A) -> Self

Binds a client to a transport and a credential source.

Source

pub const fn transport(&self) -> &'a T

Transport this client sends through.

Source

pub const fn auth(&self) -> &'a A

Credential source applied to every request.

Source

pub async fn propfind( &self, path: &DavPath, depth: Depth, body: &PropfindBody, ) -> Result<Vec<DavResource>, Error>

Asks path for the properties in body, depth levels deep.

The answer must be 207 Multi-Status; any other status becomes Error::Status with the response body retained for diagnosis. A body that is not a multistatus becomes Error::Decode.

Source

pub async fn get(&self, path: &DavPath) -> Result<Vec<u8>, Error>

Downloads the content of the resource at path.

Any non-2xx status returns Error::Status with the response body retained for diagnosis.

Source

pub async fn put( &self, path: &DavPath, body: impl Into<Vec<u8>>, content_type: Option<&str>, ) -> Result<(), Error>

Uploads body to path, optionally specifying the Content-Type header.

Any non-2xx status returns Error::Status with the response body retained for diagnosis.

Source

pub async fn mkcol(&self, path: &DavPath) -> Result<(), Error>

Creates a collection (folder) at path.

Any non-2xx status returns Error::Status with the response body retained for diagnosis.

Source

pub async fn delete(&self, path: &DavPath) -> Result<(), Error>

Deletes the resource or collection at path.

Any non-2xx status returns Error::Status with the response body retained for diagnosis.

Source

pub async fn copy( &self, source: &DavPath, destination: &DavPath, overwrite: bool, ) -> Result<(), Error>

Copies a resource from source to destination.

When overwrite is true, an existing destination is replaced; otherwise the call fails with a status error if the destination exists. Any non-2xx status returns Error::Status with the response body retained for diagnosis.

Source

pub async fn move_( &self, source: &DavPath, destination: &DavPath, overwrite: bool, ) -> Result<(), Error>

Moves a resource from source to destination.

When overwrite is true, an existing destination is replaced; otherwise the call fails with a status error if the destination exists. Any non-2xx status returns Error::Status with the response body retained for diagnosis.

Trait Implementations§

Source§

impl<'a, T: Clone + Transport, A: Clone + AuthProvider> Clone for DavClient<'a, T, A>

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
Source§

impl<'a, T: Copy + Transport, A: Copy + AuthProvider> Copy for DavClient<'a, T, A>

Source§

impl<'a, T: Debug + Transport, A: Debug + AuthProvider> Debug for DavClient<'a, T, A>

Source§

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

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

impl<T: Transport, A: AuthProvider> Display for DavClient<'_, T, A>

Source§

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

A client carries no identifying state worth logging.

Auto Trait Implementations§

§

impl<'a, T, A> Freeze for DavClient<'a, T, A>

§

impl<'a, T, A> RefUnwindSafe for DavClient<'a, T, A>

§

impl<'a, T, A> Send for DavClient<'a, T, A>
where &'a T: Send, &'a A: Send,

§

impl<'a, T, A> Sync for DavClient<'a, T, A>
where &'a T: Sync, &'a A: Sync,

§

impl<'a, T, A> Unpin for DavClient<'a, T, A>

§

impl<'a, T, A> UnsafeUnpin for DavClient<'a, T, A>

§

impl<'a, T, A> UnwindSafe for DavClient<'a, T, A>

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, 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.