Struct UploadFileRequest 

pub struct UploadFileRequest {
    pub name: String,
    pub folder_id: FolderId,
    pub file: FieldData<Bytes>,
    pub mime: Option<String>,
    pub asynchronous: Option<bool>,
    pub disable_mime_sniffing: Option<bool>,
    pub fixed_id: Option<FileId>,
    pub parent_id: Option<FileId>,
    pub processing_config: Option<String>,
}

Fields

name: String

Name of the file being uploaded

folder_id: FolderId

ID of the folder to store the file in

file: FieldData<Bytes>

The actual file you are uploading, ensure the mime type for the file is set correctly

mime: Option<String>

Optional mime type override, when not present the mime type will be extracted from UploadFileRequest::file

asynchronous: Option<bool>

Whether to process the file asynchronously returning a task response instead of waiting for the upload

disable_mime_sniffing: Option<bool>

Whether to disable mime sniffing for the file. When false/not specified if a application/octet-stream mime type is provided the file name will be used to attempt to determine the real mime type

fixed_id: Option<FileId>

Fixed file ID the file must use. Should only be used for migrating existing files and maintaining the same UUID.

Should not be provided for general use

parent_id: Option<FileId>

Optional ID of the parent file if this file is associated as a child of another file. Mainly used to associating attachments to email files

processing_config: Option<String>

Optional JSON encoded processing config

Trait Implementations

impl ComposeSchema for UploadFileRequest

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl ToSchema for UploadFileRequest

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl<S: Sync> TryFromMultipartWithState<S> for UploadFileRequest

fn try_from_multipart_with_state<'life0, 'life1, 'async_trait>( multipart: &'life0 mut Multipart, state: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Self, TypedMultipartError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates an instance from multipart data with access to application state.

impl Validate for UploadFileRequest

type Context = ()

A user-provided context.

fn validate_into( &self, __garde_user_ctx: &Self::Context, __garde_path: &mut dyn FnMut() -> Path, __garde_report: &mut Report, )

Validates Self, aggregating all validation errors into Report.

fn validate(&self) -> Result<(), Report>

where Self::Context: Default,

Validates Self, returning an Err with an aggregate of all errors if the validation failed.

fn validate_with(&self, ctx: &Self::Context) -> Result<(), Report>

Validates Self, returning an Err with an aggregate of all errors if the validation failed.