Struct File 

pub struct File(pub UploadedFile);

File extractor for a single file upload.

This extractor gets a single file from a multipart form by field name. The field name is specified via FileConfig extension on the request, or defaults to “file”.

Example

use fastapi_core::{File, FromRequest};

async fn upload(file: File) -> String {
    format!("Received: {} ({} bytes)", file.filename(), file.size())
}

Tuple Fields

0: UploadedFile

Implementations

impl File

pub fn into_inner(self) -> UploadedFile

Get the underlying uploaded file.

pub fn inner(&self) -> &UploadedFile

Get a reference to the uploaded file.

Methods from Deref<Target = UploadedFile>

pub fn field_name(&self) -> &str

Get the form field name.

pub fn filename(&self) -> &str

Get the original filename.

pub fn content_type(&self) -> &str

Get the Content-Type.

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

Get the file data.

pub fn size(&self) -> usize

Get the file size in bytes.

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

Get the file extension from the filename.

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

Read the file data as UTF-8 text.

Returns None if the data is not valid UTF-8.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Deref for File

type Target = UploadedFile

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl FromRequest for File

type Error = MultipartExtractError

Error type when extraction fails.

async fn from_request( ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request.