Struct 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: Option<Utf8PathBuf>, translations_path: Utf8PathBuf, branding: SiteBranding, features: SiteFeatures, strict: bool, ) -> Result<Self, TemplateLoadingError>

Load the templates from the given config

Parameters

• vite_manifest_path: None if we are rendering resources for reproducibility, in which case a dummy Vite manifest will be used.

Errors

Returns an error if the templates could not be loaded from disk.

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

Reload the templates on disk

Errors

Returns an error if the templates could not be reloaded from 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 OAuth 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<RegisterContext>>, ) -> Result<String, TemplateError>

Render the registration page

Errors

Returns an error if the template fails to render.

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

Render the password registration page

Errors

Returns an error if the template fails to render.

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

Render the email verification page

Errors

Returns an error if the template fails to render.

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

Render the email in use page

Errors

Returns an error if the template fails to render.

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

Render the display name page

Errors

Returns an error if the template fails to render.

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

Render the registration token 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_compat_login_policy_violation( &self, context: &WithLanguage<WithCsrf<WithSession<CompatLoginPolicyViolationContext>>>, ) -> Result<String, TemplateError>

Render the compatibility login 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_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_form_post<T: Serialize>( &self, context: &WithLanguage<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.

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

Render the ‘account deactivated’ page

Errors

Returns an error if the template fails to render.

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

Render the ‘account locked’ page

Errors

Returns an error if the template fails to render.

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

Render the ‘account logged out’ page

Errors

Returns an error if the template fails to render.

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

Render the automatic device name for OAuth 2.0 client

Errors

Returns an error if the template fails to render.

impl Templates

pub fn check_render<R: Rng + Clone>( &self, now: DateTime<Utc>, rng: &R, ) -> Result<BTreeMap<(&'static str, SampleIdentifier), String>>

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

Returns the renders in a map whose keys are template names and the values are lists of renders (according to the list of samples). Samples are stable across re-runs and can be used for acceptance testing.

Errors

Returns an error if any of the templates fails to render

Trait Implementations

impl Clone for Templates

fn clone(&self) -> Templates

Returns a duplicate 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.