1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

// This file is part of `i18n_message-rizzen-yazston` crate. For the terms of use, please see the file
// called LICENSE-BSD-3-Clause at the top level of the `i18n_message-rizzen-yazston` crate.

//! The `i18n_message` crate contains the messaging system.
//!
//! A message system that connects to a string data store, to obtain strings for the specified language using a
//! string identifier, and formatting the string to replace any placeholders within the string with provided values.
//! 
//! The message is capable of caching retrieved strings that are prepared for placeholder replacement, thus can be
//! reused without the need to parse the string for placeholders.
//! 
//! The message system makes use of all the other component crates that make up the `i18n` project. Ideally one only
//! needs to use the meta crate `i18n`, as it includes all the crates including this `i18n_message` crate.
//! 
//! # Examples
//! 
//! ```
//! use i18n_icu::IcuDataProvider;
//! use i18n_utility::LanguageTagRegistry;
//! use i18n_provider_sqlite3::ProviderSqlite3;
//! use i18n_pattern::{ PlaceholderValue, CommandRegistry };
//! use i18n_message::Message;
//! use icu_testdata::buffer;
//! use icu_provider::serde::AsDeserializingBufferProvider;
//! use std::collections::HashMap;
//! use std::rc::Rc;
//! use std::error::Error;
//! 
//! fn message() -> Result<(), Box<dyn Error>> {
//!     let buffer_provider = buffer();
//!     let data_provider = buffer_provider.as_deserializing();
//!     let icu_data_provider = Rc::new(
//!         IcuDataProvider::try_new( &data_provider )?
//!     );
//!     let language_tag_registry = Rc::new( LanguageTagRegistry::new() );
//!     let lstring_provider = ProviderSqlite3::try_new(
//!         "./i18n/", &language_tag_registry
//!     )?;
//!     let command_registry = Rc::new( CommandRegistry::new() );
//!     let message_system = Message::try_new(
//!         &icu_data_provider, &language_tag_registry, &lstring_provider, &command_registry, true, true
//!     )?;
//!     let mut values = HashMap::<String, PlaceholderValue>::new();
//!     values.insert(
//!         "identifier".to_string(),
//!         PlaceholderValue::String( "i18n_message/string_not_found".to_string() )
//!     );
//!     values.insert(
//!         "language_tag".to_string(),
//!         PlaceholderValue::String( "en-ZA".to_string() )
//!     );
//!     values.insert(
//!         "fallback".to_string(),
//!         PlaceholderValue::String( "true".to_string() )
//!     );
//!     let lstring = message_system.format(
//!         "i18n_message/string_not_found",
//!         &values,
//!         &language_tag_registry.get_language_tag( "en-ZA" ).unwrap(),
//!         None,
//!         None
//!     )?;
//!     assert_eq!(
//!         lstring.as_str(),
//!         "No string was found for identifier ‘i18n_message/string_not_found’ and language tag ‘en-ZA’. Fallback used: True.",
//!         "Check placeholder values."
//!     );
//!     Ok( () )
//! }
//! ```

pub mod error;
pub use error::*;
pub mod message;
pub use message::*;