Struct StateReason

#[non_exhaustive]
pub struct StateReason {
    pub code: Code,
    pub message: String,
    pub user_details: String,
    /* private fields */
}

The reason a spoke is inactive.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: Code

The code associated with this reason.

message: String

Human-readable details about this reason.

user_details: String

Additional information provided by the user in the RejectSpoke call.

Implementations

impl StateReason

pub fn new() -> Self

pub fn set_code<T: Into<Code>>(self, v: T) -> Self

Sets the value of code.

pub fn set_message<T: Into<String>>(self, v: T) -> Self

Sets the value of message.

pub fn set_user_details<T: Into<String>>(self, v: T) -> Self

Sets the value of user_details.

Trait Implementations

impl Clone for StateReason

fn clone(&self) -> StateReason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StateReason

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

Formats the value using the given formatter.

impl Default for StateReason

fn default() -> StateReason

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateReason

where StateReason: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StateReason

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for StateReason

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

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

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 StateReason

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StateReason