Struct Message

pub struct Message {
    pub id: i32,
    pub format: String,
    pub variables: HashMap<String, String>,
    pub send_telemetry: bool,
    pub show_user: bool,
    pub url: Option<String>,
    pub url_label: Option<String>,
    /* private fields */
}

A structured message object. Used to return errors from requests.

Fields

id: i32

Unique identifier for the message.

format: String

A format string for the message. Embedded variables have the form ‘{name}’.

If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.

variables: HashMap<String, String>

An object used as a dictionary for looking up the variables in the format string.

send_telemetry: bool

If true send to telemetry.

show_user: bool

If true show user.

url: Option<String>

An optional url where additional information about this message can be found.

url_label: Option<String>

An optional label that is presented to the user as the UI for opening the url.

Implementations

impl Message

pub fn builder() -> MessageBuilder<((), (), (), (), (), (), ())>

Create a builder for building Message. On the builder, call .id(...), .format(...), .variables(...)(optional), .send_telemetry(...)(optional), .show_user(...)(optional), .url(...)(optional), .url_label(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Message.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

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

const 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 Serialize for Message

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Message

impl StructuralPartialEq for Message