Struct Client

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

Used to interact with a tus endpoint.

Implementations

impl<'a> Client<'a>

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.

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.

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

Get info about a file on the server.

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

Upload a file to the specified upload URL.

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.

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

Get information about the tus server

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

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

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.

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

Delete a file on the server.