Struct LangFilePath

pub struct LangFilePath {
    pub pkg_name: Txt,
    pub pkg_version: Version,
    pub file: Txt,
}

Localization resource file path in the localization directory.

In the default directory layout, localization dependencies are collected using cargo zng l10n and copied to l10n/{lang}/deps/{name}/{version}/, and localization for the app (is_current_app) is placed in l10n/{lang}/.

Fields

pkg_name: Txt

Package name.

pkg_version: Version

Package version.

file: Txt

The file name.

Implementations

impl LangFilePath

pub fn new( pkg_name: impl Into<Txt>, pkg_version: Version, file: impl Into<Txt>, ) -> LangFilePath

New from package name, version and file.

pub fn current_app(file: impl Into<Txt>) -> LangFilePath

Gets a file in the current app.

This value indicates that the localization resources are directly on the l10n/{lang?}/ directories, not in the dependencies directories.

See zng_env::about() for more details.

pub fn is_current_app(&self) -> bool

Gets if this file is in the current_app resources, or the pkg_name is empty or the pkg_version.pre is #.#.#-local.

pub fn pkg_name(&self) -> Txt

Gets the normalized package name.

This is the app package name if is_current_app, otherwise is just the pkg_name value.

pub fn pkg_version(&self) -> Version

Gets the normalized package version.

This is the app version if is_current_app, otherwise is just the pkg_version value.

pub fn file(&self) -> Txt

Gets the normalized file name.

This "_" for empty file or the file.

pub fn to_path(&self, lang: &Lang) -> PathBuf

Get the file path, relative to the localization dir.

• Empty file name is the same as _.
• If package is_current_app gets {lang}/{file}.ftl.
• Else if is another package gets {lang}/deps/{pkg_name}/{pkg_version}/{file}.ftl.

pub fn matches(&self, search: &LangFilePath) -> Option<u64>

Gets a value that indicates if the resources represented by self can be used for search.

The number indicates the quality of the match:

• 0 is an exact match.
• b1 is a match with only version build differences.
• b10 is a match with only version pre differences.
• (0..u16::MAX) << 16 is a match with only patch differences and the absolute distance.
• (0..u16::MAX) << 16 * 2 is a match with minor differences and the absolute distance.
• (0..u16::MAX) << 16 * 3 is a match with major differences and the absolute distance.
• None`` is a pkg_name` mismatch.

Trait Implementations

impl Clone for LangFilePath

fn clone(&self) -> LangFilePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LangFilePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LangFilePath

fn deserialize<__D>( __deserializer: __D, ) -> Result<LangFilePath, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&'static str> for LangFilePath

fn from(file: &'static str) -> LangFilePath

Converts to this type from the input type.

impl From<String> for LangFilePath

fn from(file: String) -> LangFilePath

Converts to this type from the input type.

impl From<Txt> for LangFilePath

fn from(file: Txt) -> LangFilePath

Converts to this type from the input type.

impl Hash for LangFilePath

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoVar<LangFilePath> for &'static str

type Var = LocalVar<LangFilePath>

Variable type that will wrap the T value.

fn into_var(self) -> <&'static str as IntoVar<LangFilePath>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<LangFilePath> for String

type Var = LocalVar<LangFilePath>

Variable type that will wrap the T value.

fn into_var(self) -> <String as IntoVar<LangFilePath>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<LangFilePath> for Txt

type Var = LocalVar<LangFilePath>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<LangFilePath>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Ord for LangFilePath

fn cmp(&self, other: &LangFilePath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LangFilePath

fn eq(&self, other: &LangFilePath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LangFilePath

fn partial_cmp(&self, other: &LangFilePath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LangFilePath

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LangFilePath

impl IntoValue<LangFilePath> for &'static str

impl IntoValue<LangFilePath> for String

impl IntoValue<LangFilePath> for Txt