pub struct Client<'a> { /* private fields */ }
Expand description
Used to interact with a tus endpoint.
Implementations§
Source§impl<'a> Client<'a>
impl<'a> Client<'a>
Sourcepub fn new(http_handler: impl HttpHandler + 'a) -> Self
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.
Sourcepub fn with_method_override(http_handler: impl HttpHandler + 'a) -> Self
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.
Sourcepub fn get_info(&self, url: &str) -> Result<UploadInfo, Error>
pub fn get_info(&self, url: &str) -> Result<UploadInfo, Error>
Get info about a file on the server.
Sourcepub fn upload(&self, url: &str, path: &Path) -> Result<(), Error>
pub fn upload(&self, url: &str, path: &Path) -> Result<(), Error>
Upload a file to the specified upload URL.
Sourcepub fn upload_with_chunk_size(
&self,
url: &str,
path: &Path,
chunk_size: usize,
) -> Result<(), Error>
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.
Sourcepub fn get_server_info(&self, url: &str) -> Result<ServerInfo, Error>
pub fn get_server_info(&self, url: &str) -> Result<ServerInfo, Error>
Get information about the tus server
Sourcepub fn create(&self, url: &str, path: &Path) -> Result<String, Error>
pub fn create(&self, url: &str, path: &Path) -> Result<String, Error>
Create a file on the server, receiving the upload URL of the file.
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more