Struct FileUploadRequest 

pub struct FileUploadRequest { /* private fields */ }

Validated provider-file upload request.

This owns bytes without uploading them. Submit it through crate::ProviderBackend::upload_file and retain the returned lifecycle id for explicit owned-resource cleanup.

Examples

use providers_kit::files::FileUploadRequest;
let request = FileUploadRequest::new("notes.txt", "text/plain", b"notes".to_vec())?;
assert_eq!(request.file_name(), "notes.txt");
assert_eq!(request.media_type(), "text/plain");
assert_eq!(request.data(), b"notes");

Implementations

impl FileUploadRequest

pub fn new( file_name: impl Into<String>, media_type: impl Into<String>, data: Vec<u8>, ) -> Result<Self, KitError>

Creates a non-empty upload with a file name and media type.

Errors

Returns an input error for an empty, padded, or control-containing file name; malformed or padded MIME type/parameters; or empty file bytes.

Examples

use providers_kit::files::FileUploadRequest;
let request = FileUploadRequest::new("notes.txt", "text/plain", b"notes".to_vec())?;
assert_eq!(request.file_name(), "notes.txt");
assert_eq!(request.media_type(), "text/plain");
assert_eq!(request.data(), b"notes");

pub fn file_name(&self) -> &str

Returns the file name presented to the provider.

Examples

use providers_kit::files::FileUploadRequest;
let request = FileUploadRequest::new("notes.txt", "text/plain", b"notes".to_vec())?;
assert_eq!(request.file_name(), "notes.txt");
assert_eq!(request.media_type(), "text/plain");
assert_eq!(request.data(), b"notes");

pub fn media_type(&self) -> &str

Returns the declared media type.

Examples

use providers_kit::files::FileUploadRequest;
let request = FileUploadRequest::new("notes.txt", "text/plain", b"notes".to_vec())?;
assert_eq!(request.file_name(), "notes.txt");
assert_eq!(request.media_type(), "text/plain");
assert_eq!(request.data(), b"notes");

pub fn data(&self) -> &[u8]

Returns the raw file bytes.

Examples

use providers_kit::files::FileUploadRequest;
let request = FileUploadRequest::new("notes.txt", "text/plain", b"notes".to_vec())?;
assert_eq!(request.file_name(), "notes.txt");
assert_eq!(request.media_type(), "text/plain");
assert_eq!(request.data(), b"notes");

pub fn into_parts(self) -> (String, String, Vec<u8>)

Consumes the request into its file name, media type, and bytes.

Examples

use providers_kit::files::FileUploadRequest;
let request = FileUploadRequest::new("notes.txt", "text/plain", b"notes".to_vec())?;
let (name, media_type, bytes) = request.into_parts();
assert_eq!(name, "notes.txt");
assert_eq!(media_type, "text/plain");
assert_eq!(bytes, b"notes");

Trait Implementations

impl Clone for FileUploadRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileUploadRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileUploadRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileUploadRequest

impl PartialEq for FileUploadRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for FileUploadRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileUploadRequest