Struct Workspace 

pub struct Workspace { /* private fields */ }

The complete set of files and configuration used as input to an audit.

A Workspace gathers:

• All discovered Fluent translation files (.ftl)
• The designated canonical (reference) locale
• Explicitly configured primary locales
• Rust source files to scan for dioxus_i18n

Implementations

impl Workspace

pub fn new( fluent_files: Vec<FluentFile>, canonical: Locale, primaries: Vec<Locale>, rust_files: Vec<RustFile>, ) -> Self

Creates a new Workspace from its constituent parts.

pub fn fluent_files(&self) -> &[FluentFile]

Returns a slice of all Fluent files in the workspace.

pub fn locales(&self) -> impl Iterator<Item = &Locale>

Returns an iterator over all unique locales found in the Fluent files.

pub fn language_roots(&self) -> impl Iterator<Item = LanguageRoot>

Returns an iterator over all unique language roots present in the workspace.

pub fn locales_by_language_root( &self, root: &LanguageRoot, ) -> impl Iterator<Item = &Locale>

Returns an iterator over all locales that belong to the given language root.

pub fn fluent_files_by_locale( &self, locale: &Locale, ) -> impl Iterator<Item = &FluentFile>

Returns an iterator over all Fluent files for the exact given locale, sorted by file path (stable order).

pub fn canonical_locale(&self) -> &Locale

Returns the configured canonical (reference) locale.

pub fn is_canonical_locale(&self, locale: &Locale) -> bool

Returns true if the given locale is the canonical one.

pub fn primary_locales(&self) -> impl Iterator<Item = &Locale>

Returns an iterator over all explicitly configured primary locales.

pub fn is_primary_locale(&self, locale: &Locale) -> bool

Returns true if the given locale is one of the configured primaries.

pub fn base_locales(&self) -> impl Iterator<Item = &Locale>

Returns an iterator over all base locales — i.e. canonical + primaries.

pub fn is_base_locale(&self, locale: &Locale) -> bool

Returns true if the given locale is a base locale (canonical or primary).

pub fn variant_locales(&self, base: &Locale) -> impl Iterator<Item = &Locale>

Returns an iterator over all variant locales for the given base locale.

pub fn orphan_locales(&self) -> impl Iterator<Item = &Locale>

Returns an iterator over all orphan locales.

pub fn is_orphan_locale(&self, locale: &Locale) -> bool

Returns true if the given locale is an orphan (no matching base root).

pub fn rust_files(&self) -> &[RustFile]

Returns a slice of all Rust files included in the workspace.

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.