Skip to main content

DisplayMessage

Struct DisplayMessage 

Source
pub struct DisplayMessage<'a> {
    pub title: Cow<'a, str>,
    pub text: Cow<'a, str>,
    pub severity: Cow<'a, str>,
    pub impacts_connectivity: bool,
    pub primary_action: Option<DisplayMessageAction<'a>>,
}
Expand description

A structured health/display message pushed by the control plane (Go tailcfg.DisplayMessage, capver 117), surfaced to the user as a warning/notice about node or tailnet state.

#[serde(default)] makes every field optional (Go marshals Title/Text/Severity with no omitempty, but a tolerant decode shouldn’t fail on a sparse message), and there is deliberately no deny_unknown_fields: Go adds fields to this struct over time, and an unknown field must not fail the whole netmap decode.

Fields§

§title: Cow<'a, str>

Short, human-readable title summarizing the message.

Cow because admin/control-authored prose can contain a JSON escape (a literal ", \, or — since Go’s json.Marshal escapes &/</> by default — an &); a borrowed &str cannot decode an escaped string and would fail the whole MapResponse decode.

§text: Cow<'a, str>

Longer, human-readable body text describing the message. Cow for the same escape-tolerance reason as title (and body prose is the most likely to contain a newline).

§severity: Cow<'a, str>

Severity of the message. Go’s DisplayMessageSeverity is a string with known values "high", "medium", and "low"; this is kept as an open Cow<'a, str> (rather than a closed enum) so an unrecognized future severity decodes rather than failing the netmap.

§impacts_connectivity: bool

Whether the condition this message describes impacts the node’s connectivity.

§primary_action: Option<DisplayMessageAction<'a>>

Optional primary call-to-action (e.g. a “learn more”/“fix it” link) for this message.

Trait Implementations§

Source§

impl<'a> Clone for DisplayMessage<'a>

Source§

fn clone(&self) -> DisplayMessage<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for DisplayMessage<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for DisplayMessage<'a>

Source§

fn default() -> DisplayMessage<'a>

Returns the “default value” for a type. Read more
Source§

impl<'de: 'a, 'a> Deserialize<'de> for DisplayMessage<'a>

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a> Eq for DisplayMessage<'a>

Source§

impl<'a> PartialEq for DisplayMessage<'a>

Source§

fn eq(&self, other: &DisplayMessage<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for DisplayMessage<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for DisplayMessage<'a>

§

impl<'a> RefUnwindSafe for DisplayMessage<'a>

§

impl<'a> Send for DisplayMessage<'a>

§

impl<'a> Sync for DisplayMessage<'a>

§

impl<'a> Unpin for DisplayMessage<'a>

§

impl<'a> UnsafeUnpin for DisplayMessage<'a>

§

impl<'a> UnwindSafe for DisplayMessage<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.