Skip to main content

FileResponse

Struct FileResponse 

Source
pub struct FileResponse { /* private fields */ }
Expand description

File response for serving files.

Supports:

  • Automatic content-type inference from file extension
  • Optional Content-Disposition for downloads
  • Streaming for large files

§Examples

use fastapi_core::response::FileResponse;
use std::path::Path;

// Inline display (images, PDFs in browser)
let response = FileResponse::new(Path::new("image.png"));

// Force download with custom filename
let response = FileResponse::new(Path::new("data.csv"))
    .download_as("report.csv");

Implementations§

Source§

impl FileResponse

Source

pub fn new(path: impl Into<PathBuf>) -> Self

Create a new file response.

The content-type will be inferred from the file extension.

Source

pub fn content_type(self, content_type: impl Into<String>) -> Self

Override the content-type.

Source

pub fn download_as(self, filename: impl Into<String>) -> Self

Set as download with the specified filename.

Sets Content-Disposition: attachment; filename=“…”

Source

pub fn inline(self) -> Self

Set as inline content (default).

Sets Content-Disposition: inline

Source

pub fn path(&self) -> &Path

Get the file path.

Source

pub fn into_response_sync(self) -> Response

Read file and create response.

§Errors

Returns an error response if the file cannot be read.

Trait Implementations§

Source§

impl Debug for FileResponse

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoResponse for FileResponse

Source§

fn into_response(self) -> Response

Convert into a response.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T