rama::http::service::fs

Struct ServeFile

pub struct ServeFile(/* private fields */);

Expand description

Service that serves a file.

Implementations§

§

impl ServeFile

pub fn new(path: P) -> ServeFile
where P: AsRef<Path>,

Create a new ServeFile.

The Content-Type will be guessed from the file extension.

pub fn new_with_mime(path: P, mime: &Mime) -> ServeFile
where P: AsRef<Path>,

Create a new ServeFile with a specific mime type.

§Panics

Will panic if the mime type isn’t a valid header value.

pub fn precompressed_gzip(self) -> ServeFile

Informs the service that it should also look for a precompressed gzip version of the file.

If the client has an Accept-Encoding header that allows the gzip encoding, the file foo.txt.gz will be served instead of foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the same directory. Different precompressed variants can be combined.

pub fn precompressed_br(self) -> ServeFile

Informs the service that it should also look for a precompressed brotli version of the file.

If the client has an Accept-Encoding header that allows the brotli encoding, the file foo.txt.br will be served instead of foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the same directory. Different precompressed variants can be combined.

pub fn precompressed_deflate(self) -> ServeFile

Informs the service that it should also look for a precompressed deflate version of the file.

If the client has an Accept-Encoding header that allows the deflate encoding, the file foo.txt.zz will be served instead of foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the same directory. Different precompressed variants can be combined.

pub fn precompressed_zstd(self) -> ServeFile

Informs the service that it should also look for a precompressed zstd version of the file.

If the client has an Accept-Encoding header that allows the zstd encoding, the file foo.txt.zst will be served instead of foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the same directory. Different precompressed variants can be combined.

pub fn with_buf_chunk_size(self, chunk_size: usize) -> ServeFile

Set a specific read buffer chunk size.

The default capacity is 64kb.

pub async fn try_call<ReqBody>( &self, ctx: Context, req: Request<ReqBody>, ) -> Result<Response<Body>, Error>
where ReqBody: Send + 'static,

Call the service and get a future that contains any std::io::Error that might have happened.

See ServeDir::try_call for more details.

Trait Implementations§

§

impl Clone for ServeFile

§

fn clone(&self) -> ServeFile

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for ServeFile

§

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

Formats the value using the given formatter. Read more

§

impl<ReqBody> Service<Request<ReqBody>> for ServeFile
where ReqBody: Send + 'static,

§

type Error = <ServeDir as Service<Request<ReqBody>>>::Error

The type of error returned by the service.

§

type Response = <ServeDir as Service<Request<ReqBody>>>::Response

The type of response returned by the service.

§

async fn serve( &self, ctx: Context, req: Request<ReqBody>, ) -> Result<<ServeFile as Service<Request<ReqBody>>>::Response, <ServeFile as Service<Request<ReqBody>>>::Error>

Serve a response or error for the given request, using the given context.

§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

§

Struct ServeFileCopy item path

Implementations§

impl ServeFile

pub fn new<P>(path: P) -> ServeFilewhere P: AsRef<Path>,

pub fn new_with_mime<P>(path: P, mime: &Mime) -> ServeFilewhere P: AsRef<Path>,

§Panics

pub fn precompressed_gzip(self) -> ServeFile

pub fn precompressed_br(self) -> ServeFile

pub fn precompressed_deflate(self) -> ServeFile

pub fn precompressed_zstd(self) -> ServeFile

pub fn with_buf_chunk_size(self, chunk_size: usize) -> ServeFile

pub async fn try_call<ReqBody>( &self, ctx: Context, req: Request<ReqBody>, ) -> Result<Response<Body>, Error>where ReqBody: Send + 'static,

Trait Implementations§

impl Clone for ServeFile

fn clone(&self) -> ServeFile

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

impl Debug for ServeFile

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

impl<ReqBody> Service<Request<ReqBody>> for ServeFilewhere ReqBody: Send + 'static,

type Error = <ServeDir as Service<Request<ReqBody>>>::Error

type Response = <ServeDir as Service<Request<ReqBody>>>::Response

async fn serve( &self, ctx: Context, req: Request<ReqBody>, ) -> Result<<ServeFile as Service<Request<ReqBody>>>::Response, <ServeFile as Service<Request<ReqBody>>>::Error>

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Auto Trait Implementations§

impl !Freeze for ServeFile

impl RefUnwindSafe for ServeFile

impl Send for ServeFile

impl Sync for ServeFile

impl Unpin for ServeFile

impl UnwindSafe for ServeFile

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

fn with_current_context(self) -> WithContext<Self> ⓘ

impl<S, Body> HttpClientExt for Swhere S: Service<Request<Body>, Response = Response<Body>>, <S as Service<Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>>,

type ExecuteResponse = Response<Body>

type ExecuteError = <S as Service<Request<Body>>>::Error

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>where RequestBody: Into<Body>,

fn execute( &self, ctx: Context, request: Request<Body>, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>

impl<S, Body> HttpClientWebSocketExt<Body> for Swhere S: Service<Request<Body>, Response = Response<Body>>, <S as Service<Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>>,

fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>where RequestBody: Into<Body>,

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<S, R> IntoEndpointService<(R,)> for Swhere S: Service<Request<Body>, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

fn into_endpoint_service( self, ) -> impl Service<Request<Body>, Response = Response<Body>, Error = Infallible>

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

Struct ServeFile

pub fn new<P>(path: P) -> ServeFile
where P: AsRef<Path>,

pub fn new_with_mime<P>(path: P, mime: &Mime) -> ServeFile
where P: AsRef<Path>,

pub async fn try_call<ReqBody>( &self, ctx: Context, req: Request<ReqBody>, ) -> Result<Response<Body>, Error>
where ReqBody: Send + 'static,

impl<ReqBody> Service<Request<ReqBody>> for ServeFile
where ReqBody: Send + 'static,

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

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

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

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

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

impl<S, Body> HttpClientExt for S
where S: Service<Request<Body>, Response = Response<Body>>, <S as Service<Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>>,

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
where RequestBody: Into<Body>,

impl<S, Body> HttpClientWebSocketExt<Body> for S
where S: Service<Request<Body>, Response = Response<Body>>, <S as Service<Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>>,

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
where RequestBody: Into<Body>,

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<S, R> IntoEndpointService<(R,)> for S
where S: Service<Request<Body>, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

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

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

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

impl<T> ErasedDestructor for T
where T: 'static,