Struct ServeEmbed

pub struct ServeEmbed<E: RustEmbed + Clone> { /* private fields */ }

Expand description

ServeEmbed is a struct that represents a service for serving embedded files.

§Parameters

E: A type that implements the RustEmbed and Clone trait. This type represents the embedded files.

§Example

#[derive(RustEmbed, Clone)]
#[folder = "examples/assets/"]
struct Assets;

let listener = TcpListener::bind("127.0.0.1:8080").await?;
let serve_assets = ServeEmbed::<Assets>::new();
let app = axum::Router::new().nest_service("/", serve_assets);
axum::serve(listener, app).await?;

Implementations§

impl<E: RustEmbed + Clone> ServeEmbed<E>

pub fn new() -> Self

Constructs a new ServeEmbed instance with default parameters.

This function calls with_parameters internally with None for fallback_file, FallbackBehavior::NotFound for fallback_behavior, and "index.html" for index_file.

§Returns

A new ServeEmbed instance with default parameters.

pub fn with_parameters( fallback_file: Option<String>, fallback_behavior: FallbackBehavior, index_file: Option<String>, ) -> Self

Constructs a new ServeEmbed instance with the provided parameters.

§Parameters

fallback_file: The path of the file to serve when a requested file is not found. If None, a default 404 response is served.
fallback_behavior: The behavior of the server when a requested file is not found. Please see FallbackBehavior for more information.
index_file: The name of the file to serve when a directory is accessed. If None, a 404 response is served for directory.

§Returns

A new ServeEmbed instance.

Trait Implementations§

impl<E: Clone + RustEmbed + Clone> Clone for ServeEmbed<E>

fn clone(&self) -> ServeEmbed<E>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<E: Debug + RustEmbed + Clone> Debug for ServeEmbed<E>

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

Formats the value using the given formatter. Read more

impl<E: RustEmbed + Clone, T: Send + 'static> Service<Request<T>> for ServeEmbed<E>

type Response = Response<Body>

Responses given by the service.

type Error = Infallible

Errors produced by the service.

type Future = ServeFuture<E, T>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more

fn call(&mut self, req: Request<T>) -> Self::Future

Process the request and return the response asynchronously. Read more

Auto Trait Implementations§

impl<E> Freeze for ServeEmbed<E>

impl<E> RefUnwindSafe for ServeEmbed<E>
where E: RefUnwindSafe,

impl<E> Send for ServeEmbed<E>
where E: Send,

impl<E> Sync for ServeEmbed<E>
where E: Sync,

impl<E> Unpin for ServeEmbed<E>
where E: Unpin,

impl<E> UnwindSafe for ServeEmbed<E>
where E: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.