Struct fluent_bundle::FluentMessage [−][src]
pub struct FluentMessage<'m> { /* fields omitted */ }
FluentMessage
is a basic translation unit of the Fluent system.
The instance of a message is returned from the
FluentBundle::get_message
method, for the lifetime of the FluentBundle
instance.
Example
use fluent_bundle::{FluentResource, FluentBundle}; let source = r#" hello-world = Hello World! "#; let resource = FluentResource::try_new(source.to_string()) .expect("Failed to parse the resource."); let mut bundle = FluentBundle::default(); bundle.add_resource(resource) .expect("Failed to add a resource."); let msg = bundle.get_message("hello-world") .expect("Failed to retrieve a message."); assert!(msg.value().is_some());
That value can be then passed to
FluentBundle::format_pattern
to be formatted
within the context of a given FluentBundle
instance.
Compound Message
A message may contain a value
, but it can also contain a list of FluentAttribute
elements.
If a message contains attributes, it is called a “compound” message.
In such case, the message contains a list of key-value attributes that represent different translation values associated with a single translation unit.
This is useful for scenarios where a FluentMessage
is associated with a
complex User Interface widget which has multiple attributes that need to be translated.
confirm-modal = Are you sure?
.confirm = Yes
.cancel = No
.tooltip = Closing the window will lose all unsaved data.
Implementations
impl<'m> FluentMessage<'m>
[src]
impl<'m> FluentMessage<'m>
[src]pub fn value(&self) -> Option<&'m Pattern<&'m str>>
[src]
Retrieves an option of a ast::Pattern
.
Example
let msg = bundle.get_message("hello-world") .expect("Failed to retrieve a message."); if let Some(value) = msg.value() { let mut err = vec![]; assert_eq!( bundle.format_pattern(value, None, &mut err), "Hello World!" ); }
pub fn attributes(&self) -> impl Iterator<Item = FluentAttribute<'m>>
[src]
An iterator over FluentAttribute
elements.
Example
let msg = bundle.get_message("hello-world") .expect("Failed to retrieve a message."); let mut err = vec![]; for attr in msg.attributes() { let _ = bundle.format_pattern(attr.value(), None, &mut err); }
pub fn get_attribute(&self, key: &str) -> Option<FluentAttribute<'m>>
[src]
Retrieve a single FluentAttribute
element.
Example
let msg = bundle.get_message("hello-world") .expect("Failed to retrieve a message."); let mut err = vec![]; if let Some(attr) = msg.get_attribute("label") { assert_eq!( bundle.format_pattern(attr.value(), None, &mut err), "This is a label" ); }
Trait Implementations
impl<'m> From<&'m Message<&'m str>> for FluentMessage<'m>
[src]
impl<'m> From<&'m Message<&'m str>> for FluentMessage<'m>
[src]impl<'m> PartialEq<FluentMessage<'m>> for FluentMessage<'m>
[src]
impl<'m> PartialEq<FluentMessage<'m>> for FluentMessage<'m>
[src]fn eq(&self, other: &FluentMessage<'m>) -> bool
[src]
fn ne(&self, other: &FluentMessage<'m>) -> bool
[src]
impl<'m> StructuralPartialEq for FluentMessage<'m>
[src]
impl<'m> StructuralPartialEq for FluentMessage<'m>
[src]Auto Trait Implementations
impl<'m> RefUnwindSafe for FluentMessage<'m>
impl<'m> RefUnwindSafe for FluentMessage<'m>
impl<'m> Send for FluentMessage<'m>
impl<'m> Send for FluentMessage<'m>
impl<'m> Sync for FluentMessage<'m>
impl<'m> Sync for FluentMessage<'m>
impl<'m> Unpin for FluentMessage<'m>
impl<'m> Unpin for FluentMessage<'m>
impl<'m> UnwindSafe for FluentMessage<'m>
impl<'m> UnwindSafe for FluentMessage<'m>