Struct sep2_common::packages::messaging::TextMessage

pub struct TextMessage {

    pub originator: Option<String20>,
    pub priority: PriorityType,
    pub text_message: String,
    pub creation_time: TimeType,
    pub event_status: EventStatus,
    pub interval: DateTimeInterval,
    pub mrid: MRIDType,
    pub description: Option<String32>,
    pub version: Option<VersionType>,
    pub subscribable: Option<SubscribableType>,
    pub reply_to: Option<String>,
    pub response_required: Option<ResponseRequired>,
    pub href: Option<String>,
}

Available on crate feature messaging only.

Text message such as a notification.

Fields

originator: Option<String20>

Indicates the human-readable name of the publisher of the message

priority: PriorityType

The priority is used to inform the client of the priority of the particular message. Devices with constrained or limited resources for displaying Messages should use this attribute to determine how to handle displaying currently active Messages (e.g. if a device uses a scrolling method with a single Message viewable at a time it MAY want to push a low priority Message to the background and bring a newly received higher priority Message to the foreground).

text_message: String

The textMessage attribute contains the actual UTF-8 encoded text to be displayed in conjunction with the messageLength attribute which contains the overall length of the textMessage attribute. Clients and servers SHALL support a reception of a Message of 100 bytes in length. Messages that exceed the clients display size will be left to the client to choose what method to handle the message (truncation, scrolling, etc.).

creation_time: TimeType

The time at which the Event was created.

event_status: EventStatus

interval: DateTimeInterval

The period during which the Event applies.

mrid: MRIDType

The global identifier of the object.

description: Option<String32>

The description is a human readable text describing or naming the object.

version: Option<VersionType>

Contains the version number of the object. See the type definition for details.

subscribable: Option<SubscribableType>

Indicates whether or not subscriptions are supported for this resource, and whether or not conditional (thresholds) are supported. If not specified, is “not subscribable” (0).

reply_to: Option<String>

A reference to the response resource address (URI). Required on a response to a GET if responseRequired is “true”.

response_required: Option<ResponseRequired>

Indicates whether or not a response is required upon receipt, creation or update of this resource. Responses shall be posted to the collection specified in “replyTo”. If the resource has a deviceCategory field, devices that match one or more of the device types indicated in deviceCategory SHALL respond according to the rules listed below. If the category does not match, the device SHALL NOT respond. If the resource does not have a deviceCategory field, a device receiving the resource SHALL respond according to the rules listed below. Value encoded as hex according to the following bit assignments, any combination is possible. See Table 27 for the list of appropriate Response status codes to be sent for these purposes. 0 - End device shall indicate that message was received 1 - End device shall indicate specific response. 2 - End user / customer response is required. All other values reserved.

href: Option<String>

A reference to the resource address (URI). Required in a response to a GET, ignored otherwise.

Trait Implementations

impl Clone for TextMessage

fn clone(&self) -> TextMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextMessage

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

Formats the value using the given formatter.

impl Default for TextMessage

fn default() -> TextMessage

Returns the “default value” for a type.

impl Ord for TextMessage

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TextMessage> for TextMessage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<TextMessage> for TextMessage

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SEEvent for TextMessage

fn creation_time(&self) -> TimeType

fn event_status(&self) -> &EventStatus

fn interval(&self) -> &DateTimeInterval

impl SEIdentifiedObject for TextMessage

fn mrid(&self) -> &MRIDType

fn description(&self) -> Option<&String32>

fn version(&self) -> Option<VersionType>

impl SEResource for TextMessage

fn href(&self) -> Option<&str>

impl SERespondableResource for TextMessage

fn reply_to(&self) -> Option<&str>

fn response_required(&self) -> Option<ResponseRequired>

impl SESubscribableResource for TextMessage

fn subscribable(&self) -> Option<SubscribableType>

impl Validate for TextMessage

fn validate(&self) -> Result<(), String>

impl YaDeserialize for TextMessage

fn deserialize<R: Read>(reader: &mut Deserializer<R>) -> Result<Self, String>where Self: Sized,

impl YaSerialize for TextMessage

fn name() -> &'static strwhere Self: Sized,

fn serialize<W: Write>(&self, writer: &mut Serializer<W>) -> Result<(), String>where Self: Sized,

fn serialize_attributes( &self, source_attributes: Vec<OwnedAttribute>, source_namespace: Namespace ) -> Result<(Vec<OwnedAttribute>, Namespace), String>where Self: Sized,

impl Eq for TextMessage

impl SERespondableSubscribableIdentifiedObject for TextMessage

impl StructuralEq for TextMessage

impl StructuralPartialEq for TextMessage