Struct FluentCatalog 

pub struct FluentCatalog { /* private fields */ }

Fluent catalog keyed by gatekeep reason codes.

Implementations

impl FluentCatalog

pub fn new() -> Self

Creates an empty catalog.

pub fn set_fallback_locale( &mut self, locale: impl AsRef<str>, ) -> Result<(), FluentCatalogError>

Sets the locale to try after the requested locale cannot render.

Errors

Returns FluentCatalogError::InvalidLocale when locale is not a well-formed Unicode language identifier.

pub fn with_fallback_locale( self, locale: impl AsRef<str>, ) -> Result<Self, FluentCatalogError>

Returns this catalog with a fallback locale configured.

Errors

Returns FluentCatalogError::InvalidLocale when locale is not a well-formed Unicode language identifier.

pub fn set_hidden_message( &mut self, message_id: impl Into<String>, fallback: impl Into<String>, ) -> Result<(), FluentCatalogError>

Sets the generic message used for hidden denials.

Hidden denials must not render their specific reason code because that can disclose the protected resource’s existence. The catalog looks up message_id in the requested locale and then the fallback locale; if no message exists, it returns fallback.

Errors

Returns FluentCatalogError::EmptyMessageId when message_id is blank or FluentCatalogError::EmptyFallbackMessage when fallback is blank.

pub fn with_hidden_message( self, message_id: impl Into<String>, fallback: impl Into<String>, ) -> Result<Self, FluentCatalogError>

Returns this catalog with a generic hidden-denial message configured.

Errors

Returns FluentCatalogError::EmptyMessageId when message_id is blank or FluentCatalogError::EmptyFallbackMessage when fallback is blank.

pub fn add_resource( &mut self, locale: impl AsRef<str>, source: impl Into<String>, ) -> Result<(), FluentCatalogError>

Adds an FTL resource to the bundle for locale.

Multiple resources may be added to one locale. Fluent duplicate-message errors are reported instead of overriding an earlier message.

Errors

Returns FluentCatalogError when the locale is invalid, the FTL source has parse errors, or Fluent rejects the resource for that locale.

pub fn with_resource( self, locale: impl AsRef<str>, source: impl Into<String>, ) -> Result<Self, FluentCatalogError>

Returns this catalog with an FTL resource added.

Errors

Returns FluentCatalogError when the resource cannot be added.

pub fn render_reason(&self, reason: &DenialReason, locale: &Locale) -> String

Renders reason, falling back to the stable reason code for forbidden denials or to the generic hidden message for hidden denials.

pub fn try_render_reason( &self, reason: &DenialReason, locale: &Locale, ) -> Option<String>

Renders reason only when a matching Fluent message exists and resolves without runtime formatting errors.

Hidden denials use the configured generic hidden message id instead of reason.code.

Trait Implementations

impl Default for FluentCatalog

fn default() -> Self

Returns the “default value” for a type.

impl ReasonCatalog for FluentCatalog

fn render(&self, reason: &DenialReason, locale: &Locale) -> String

Renders a denial reason for the requested locale.