Struct Client

Source
pub struct Client<'a> { /* private fields */ }
Expand description

Used to interact with a tus endpoint.

Implementations§

Source§

impl<'a> Client<'a>

Source

pub fn new(http_handler: impl HttpHandler + 'a) -> Self

Instantiates a new instance of Client. http_handler needs to implement the HttpHandler trait. A default implementation of this trait for the reqwest library is available by enabling the reqwest feature.

Source

pub fn with_method_override(http_handler: impl HttpHandler + 'a) -> Self

Some environments might not support using the HTTP methods PATCH and DELETE. Use this method to create a Client which uses the X-HTTP-METHOD-OVERRIDE header to specify these methods instead.

Source

pub fn get_info(&self, url: &str) -> Result<UploadInfo, Error>

Get info about a file on the server.

Source

pub fn upload(&self, url: &str, path: &Path) -> Result<(), Error>

Upload a file to the specified upload URL.

Source

pub fn upload_with_chunk_size( &self, url: &str, path: &Path, chunk_size: usize, ) -> Result<(), Error>

Upload a file to the specified upload URL with the given chunk size.

Source

pub fn get_server_info(&self, url: &str) -> Result<ServerInfo, Error>

Get information about the tus server

Source

pub fn create(&self, url: &str, path: &Path) -> Result<String, Error>

Create a file on the server, receiving the upload URL of the file.

Source

pub fn create_with_metadata( &self, url: &str, path: &Path, metadata: HashMap<String, String>, ) -> Result<String, Error>

Create a file on the server including the specified metadata, receiving the upload URL of the file.

Source

pub fn delete(&self, url: &str) -> Result<(), Error>

Delete a file on the server.

Auto Trait Implementations§

§

impl<'a> Freeze for Client<'a>

§

impl<'a> !RefUnwindSafe for Client<'a>

§

impl<'a> !Send for Client<'a>

§

impl<'a> !Sync for Client<'a>

§

impl<'a> Unpin for Client<'a>

§

impl<'a> !UnwindSafe for Client<'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> 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, 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.