Struct TypedMessage 

pub struct TypedMessage<'a> { /* private fields */ }

Generic textual message with type prefix.

Use this message type to display any kinds of warnings, errors etc. The type prefix can be stylized in text mode.

Implementations

impl<'a> TypedMessage<'a>

pub fn styled(ty: &'a str, type_style: &'a str, message: &'a str) -> Self

Create a message with the given type, its style and the message text proper.

pub fn naked_text(ty: &'a str, message: &'a str) -> Self

Create a message that does not print type prefix in text mode.

Example

Scarb uses this for emitting Cairo compiler diagnostics. In text mode it prints the diagnostic as-is, while in JSON mode it wraps it as:

{"type":"diagnostic","message":"<diagnostic>"}

pub fn with_code(self, code: &'a str) -> Self

Sometimes, a message may be associated with a short machine-readable descriptor. For example, some compilers associate numerical codes with various kinds of errors that can be produced. The optional code field allows carrying this information. This will be shown as suffix in text mode, and as a code field in structured mode.

Trait Implementations

impl Message for TypedMessage<'_>

fn text(self) -> String

Return textual representation of this message.

fn structured<S: Serializer>(self, ser: S) -> Result<S::Ok, S::Error>

Serialize this structured message to a serializer which is routed to Ui output stream.

impl<'a> Serialize for TypedMessage<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.