Struct mas_templates::Templates

pub struct Templates { /* private fields */ }

Wrapper around minijinja::Environment helping rendering the various templates

Implementations

impl Templates

pub async fn load( path: Utf8PathBuf, url_builder: UrlBuilder, vite_manifest_path: Utf8PathBuf, translations_path: Utf8PathBuf, branding: SiteBranding, features: SiteFeatures, ) -> Result<Self, TemplateLoadingError>

Load the templates from the given config

pub async fn reload(&self) -> Result<(), TemplateLoadingError>

Reload the templates on disk

pub fn translator(&self) -> Arc<Translator>

Get the translator

impl Templates

pub fn render_not_found( &self, context: &WithLanguage<NotFoundContext>, ) -> Result<String, TemplateError>

Render the not found fallback page

Errors

Returns an error if the template fails to render.

pub fn render_app( &self, context: &WithLanguage<AppContext>, ) -> Result<String, TemplateError>

Render the frontend app

Errors

Returns an error if the template fails to render.

pub fn render_swagger( &self, context: &ApiDocContext, ) -> Result<String, TemplateError>

Render the Swagger API reference

Errors

Returns an error if the template fails to render.

pub fn render_swagger_callback( &self, context: &ApiDocContext, ) -> Result<String, TemplateError>

Render the Swagger OAuth2 callback page

Errors

Returns an error if the template fails to render.

pub fn render_login( &self, context: &WithLanguage<WithCsrf<LoginContext>>, ) -> Result<String, TemplateError>

Render the login page

Errors

Returns an error if the template fails to render.

pub fn render_register( &self, context: &WithLanguage<WithCsrf<WithCaptcha<RegisterContext>>>, ) -> Result<String, TemplateError>

Render the registration page

Errors

Returns an error if the template fails to render.

pub fn render_consent( &self, context: &WithLanguage<WithCsrf<WithSession<ConsentContext>>>, ) -> Result<String, TemplateError>

Render the client consent page

Errors

Returns an error if the template fails to render.

pub fn render_policy_violation( &self, context: &WithLanguage<WithCsrf<WithSession<PolicyViolationContext>>>, ) -> Result<String, TemplateError>

Render the policy violation page

Errors

Returns an error if the template fails to render.

pub fn render_sso_login( &self, context: &WithLanguage<WithCsrf<WithSession<CompatSsoContext>>>, ) -> Result<String, TemplateError>

Render the legacy SSO login consent page

Errors

Returns an error if the template fails to render.

pub fn render_index( &self, context: &WithLanguage<WithCsrf<WithOptionalSession<IndexContext>>>, ) -> Result<String, TemplateError>

Render the home page

Errors

Returns an error if the template fails to render.

pub fn render_account_verify_email( &self, context: &WithLanguage<WithCsrf<WithSession<EmailVerificationPageContext>>>, ) -> Result<String, TemplateError>

Render the email verification page

Errors

Returns an error if the template fails to render.

pub fn render_account_add_email( &self, context: &WithLanguage<WithCsrf<WithSession<EmailAddContext>>>, ) -> Result<String, TemplateError>

Render the email verification page

Errors

Returns an error if the template fails to render.

pub fn render_recovery_start( &self, context: &WithLanguage<WithCsrf<RecoveryStartContext>>, ) -> Result<String, TemplateError>

Render the account recovery start page

Errors

Returns an error if the template fails to render.

pub fn render_recovery_progress( &self, context: &WithLanguage<WithCsrf<RecoveryProgressContext>>, ) -> Result<String, TemplateError>

Render the account recovery start page

Errors

Returns an error if the template fails to render.

pub fn render_recovery_finish( &self, context: &WithLanguage<WithCsrf<RecoveryFinishContext>>, ) -> Result<String, TemplateError>

Render the account recovery finish page

Errors

Returns an error if the template fails to render.

pub fn render_recovery_expired( &self, context: &WithLanguage<WithCsrf<RecoveryExpiredContext>>, ) -> Result<String, TemplateError>

Render the account recovery link expired page

Errors

Returns an error if the template fails to render.

pub fn render_recovery_consumed( &self, context: &WithLanguage<EmptyContext>, ) -> Result<String, TemplateError>

Render the account recovery link consumed page

Errors

Returns an error if the template fails to render.

pub fn render_recovery_disabled( &self, context: &WithLanguage<EmptyContext>, ) -> Result<String, TemplateError>

Render the account recovery disabled page

Errors

Returns an error if the template fails to render.

pub fn render_reauth( &self, context: &WithLanguage<WithCsrf<WithSession<ReauthContext>>>, ) -> Result<String, TemplateError>

Render the re-authentication form

Errors

Returns an error if the template fails to render.

pub fn render_form_post<T: Serialize>( &self, context: &FormPostContext<T>, ) -> Result<String, TemplateError>

Render the form used by the form_post response mode

Errors

Returns an error if the template fails to render.

pub fn render_error( &self, context: &ErrorContext, ) -> Result<String, TemplateError>

Render the HTML error page

Errors

Returns an error if the template fails to render.

pub fn render_email_recovery_txt( &self, context: &WithLanguage<EmailRecoveryContext>, ) -> Result<String, TemplateError>

Render the email recovery email (plain text variant)

Errors

Returns an error if the template fails to render.

pub fn render_email_recovery_html( &self, context: &WithLanguage<EmailRecoveryContext>, ) -> Result<String, TemplateError>

Render the email recovery email (HTML text variant)

Errors

Returns an error if the template fails to render.

pub fn render_email_recovery_subject( &self, context: &WithLanguage<EmailRecoveryContext>, ) -> Result<String, TemplateError>

Render the email recovery subject

Errors

Returns an error if the template fails to render.

pub fn render_email_verification_txt( &self, context: &WithLanguage<EmailVerificationContext>, ) -> Result<String, TemplateError>

Render the email verification email (plain text variant)

Errors

Returns an error if the template fails to render.

pub fn render_email_verification_html( &self, context: &WithLanguage<EmailVerificationContext>, ) -> Result<String, TemplateError>

Render the email verification email (HTML text variant)

Errors

Returns an error if the template fails to render.

pub fn render_email_verification_subject( &self, context: &WithLanguage<EmailVerificationContext>, ) -> Result<String, TemplateError>

Render the email verification subject

Errors

Returns an error if the template fails to render.

pub fn render_upstream_oauth2_link_mismatch( &self, context: &WithLanguage<WithCsrf<WithSession<UpstreamExistingLinkContext>>>, ) -> Result<String, TemplateError>

Render the upstream link mismatch message

Errors

Returns an error if the template fails to render.

pub fn render_upstream_oauth2_suggest_link( &self, context: &WithLanguage<WithCsrf<WithSession<UpstreamSuggestLink>>>, ) -> Result<String, TemplateError>

Render the upstream suggest link message

Errors

Returns an error if the template fails to render.

pub fn render_upstream_oauth2_do_register( &self, context: &WithLanguage<WithCsrf<UpstreamRegister>>, ) -> Result<String, TemplateError>

Render the upstream register screen

Errors

Returns an error if the template fails to render.

pub fn render_device_link( &self, context: &WithLanguage<DeviceLinkContext>, ) -> Result<String, TemplateError>

Render the device code link page

Errors

Returns an error if the template fails to render.

pub fn render_device_consent( &self, context: &WithLanguage<WithCsrf<WithSession<DeviceConsentContext>>>, ) -> Result<String, TemplateError>

Render the device code consent page

Errors

Returns an error if the template fails to render.

impl Templates

pub fn check_render(&self, now: DateTime<Utc>, rng: &mut impl Rng) -> Result<()>

Render all templates with the generated samples to check if they render properly

Errors

Returns an error if any of the templates fails to render

Trait Implementations

impl Clone for Templates

fn clone(&self) -> Templates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Templates

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

Formats the value using the given formatter.