Struct LocalizedString

pub struct LocalizedString {
    pub args: Option<HashMap<String, String>>,
    pub message: Option<String>,
    pub token: Option<String>,
}

A message representing a user-facing string whose value may need to be translated before being displayed.

This type is not used in any activity, and only used as part of another schema.

Fields

args: Option<HashMap<String, String>>

A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

message: Option<String>

The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

token: Option<String>

The token identifying the message, e.g. ‘METRIC_READ_CPU’. This should be unique within the service.

Trait Implementations

impl Clone for LocalizedString

fn clone(&self) -> LocalizedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalizedString

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

Formats the value using the given formatter.

impl Default for LocalizedString

fn default() -> LocalizedString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalizedString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LocalizedString

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for LocalizedString