pub struct ApiServer { /* private fields */ }Expand description
Implementations§
Source§impl ApiServer
impl ApiServer
Sourcepub fn new(auth_framework: Arc<AuthFramework>) -> Self
pub fn new(auth_framework: Arc<AuthFramework>) -> Self
Create a server with the default ApiServerConfig.
Sourcepub fn with_config(
auth_framework: Arc<AuthFramework>,
config: ApiServerConfig,
) -> Self
pub fn with_config( auth_framework: Arc<AuthFramework>, config: ApiServerConfig, ) -> Self
Create a server with a custom ApiServerConfig.
Sourcepub fn with_trusted_proxies(self, proxies: Vec<IpAddr>) -> Self
pub fn with_trusted_proxies(self, proxies: Vec<IpAddr>) -> Self
Declare the reverse proxies in front of this server (by the peer address they
connect from). Only requests arriving from these addresses have their
X-Forwarded-For header believed when identifying the client for rate limiting;
from anyone else the header is ignored.
Sourcepub fn with_email_verification_sender(
self,
sender: Arc<dyn EmailVerificationSender>,
) -> Self
pub fn with_email_verification_sender( self, sender: Arc<dyn EmailVerificationSender>, ) -> Self
Install the channel that delivers email-verification tokens. Without one, the verification endpoints cannot deliver anything and email verification cannot complete.
Sourcepub async fn build_router(&self) -> Result<Router>
pub async fn build_router(&self) -> Result<Router>
Assemble the Axum Router with all route groups and middleware.
Sourcepub fn config(&self) -> &ApiServerConfig
pub fn config(&self) -> &ApiServerConfig
Get server configuration
Auto Trait Implementations§
impl !RefUnwindSafe for ApiServer
impl !UnwindSafe for ApiServer
impl Forget for ApiServer
impl Freeze for ApiServer
impl Send for ApiServer
impl Sync for ApiServer
impl Unpin for ApiServer
impl UnsafeUnpin for ApiServer
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more