Struct NamedFile

pub struct NamedFile { /* private fields */ }

A file with an associated name.

Implementations

impl NamedFile

pub fn new(file_name: impl Into<String>) -> Self

Creates a new instance with the specific file name.

pub fn set_field_name(&mut self, field_name: impl Into<String>)

Sets the field name.

pub fn set_file_name(&mut self, file_name: impl Into<String>)

Sets the file name.

pub fn set_content_type(&mut self, content_type: Mime)

Sets the content type.

pub fn set_bytes(&mut self, bytes: impl Into<Bytes>)

Sets the bytes.

pub fn set_extra_attribute(&mut self, key: &str, value: impl Into<JsonValue>)

Sets the extra attribute.

Note

Currently, we support the following built-in attributes: checksum | chunk_number | chunk_size | total_chunks.

pub fn append_extra_attributes(&mut self, attrs: &mut Map)

Appends the extra attributes.

pub fn field_name(&self) -> Option<&str>

Returns the field name corresponding to the file.

pub fn file_name(&self) -> Option<&str>

Returns the file name.

pub fn content_type(&self) -> Option<&Mime>

Returns the content type.

pub fn file_size(&self) -> u64

Returns the file size.

pub fn bytes(&self) -> Bytes

Returns the bytes.

pub fn extra(&self) -> &Map

Returns a reference to the extra attributes.

pub fn chunk_number(&self) -> Option<usize>

Returns the chunk number for the file.

pub fn chunk_size(&self) -> Option<usize>

Returns the chunk size for the file.

pub fn total_chunks(&self) -> Option<usize>

Returns the total number of file chunks.

pub fn checksum(&self) -> Bytes

Returns the checksum for the file.

Note

If you would like to obtain a hex-formated string, you can use the LowerHex or UpperHex implementations for Bytes.

pub fn etag(&self) -> EntityTag

Returns the ETag for the file.

pub fn content_md5(&self) -> String

Returns the content MD5.

pub fn to_hex_string(&self) -> String

Returns the hex representation of the file bytes.

pub fn to_base64_string(&self) -> String

Returns the base64 representation of the file bytes.

pub fn read_string(&mut self, data: String) -> Result<(), Error>

Reads the string and sets the bytes.

pub fn read_hex_string(&mut self, data: &str) -> Result<(), Error>

Reads the hex string and sets the bytes.

pub fn read_base64_string(&mut self, data: &str) -> Result<(), Error>

Reads the base64 string and sets the bytes.

pub fn read_from_local(&mut self, path: impl AsRef<Path>) -> Result<(), Error>

Reads the entire contents of a local file and sets the bytes.

pub fn write(&self, path: impl AsRef<Path>) -> Result<(), Error>

Writes the bytes into a file at the path. If the extra attributes contain a chunk_number value, a .{chunk_number}.part suffix will be adjoined to the path.

pub fn append(&self, path: impl AsRef<Path>) -> Result<(), Error>

Appends the bytes into a file at the path.

pub fn encrypt_with(&mut self, key: impl AsRef<[u8]>) -> Result<(), Error>

Encrypts the file with a key.

pub fn decrypt_with(&mut self, key: impl AsRef<[u8]>) -> Result<(), Error>

Decrypts the file with a key.

pub fn rename_file_stem(&mut self, file_stem: &str) -> Result<(), Error>

Renames the stem portion of the file name.

pub fn split_chunks(&self, chunk_size: usize) -> Vec<Self>

Splits the file into chunks with the chunk_size. The file name of chunks will end with .{chunk_number}.part and the extra attributes will contain the chunk_number and total_chunks.

pub fn try_concat_chunks( path: impl AsRef<Path>, total_chunks: usize, ) -> Result<Self, Error>

Attempts to concat the file chunks into a whole. The path should not contain the .{chunk_number}.part suffix.

pub fn try_from_local(path: impl AsRef<Path>) -> Result<Self, Error>

Attempts to create an instance from reading a local file.

pub async fn try_from_multipart_field(field: Field<'_>) -> Result<Self, Error>

Attempts to create an instance from a field in a multipart stream.

pub async fn try_from_multipart(multipart: Multipart<'_>) -> Result<Self, Error>

Attempts to create a file in a multipart stream. If the extra attributes contain a chunk_size or checksum value, the file integrity will be checked.

pub async fn try_collect_from_multipart( multipart: Multipart<'_>, ) -> Result<Vec<Self>, Error>

Attempts to create a list of files in a multipart stream.

pub async fn download_from( url: &str, options: Option<&Map>, ) -> Result<Self, Error>

Available on crate feature http-client only.

Downloads a file from the URL.

pub async fn upload_to( &self, url: &str, options: Option<&Map>, ) -> Result<Response, Error>

Available on crate feature http-client only.

Uploads the file to the URL.

Trait Implementations

impl AsRef<[u8]> for NamedFile

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NamedFile

fn clone(&self) -> NamedFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NamedFile

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

Formats the value using the given formatter.

impl Default for NamedFile

fn default() -> NamedFile

Returns the “default value” for a type.

impl<'a> From<&'a NamedFile> for Buffer

Available on crate feature accessor only.

fn from(file: &'a NamedFile) -> Self

Converts to this type from the input type.

impl<'a> From<&'a NamedFile> for Bytes

fn from(file: &'a NamedFile) -> Self

Converts to this type from the input type.

impl From<NamedFile> for Buffer

Available on crate feature accessor only.

fn from(file: NamedFile) -> Self

Converts to this type from the input type.

impl From<NamedFile> for Bytes

fn from(file: NamedFile) -> Self

Converts to this type from the input type.