class I3::Message

Overview

Represents a message exchanged during a Connection.

Message instances are of one of the following types:

.new(type, payload = "")
Creates a new Message with the given type and payload.

.from_io(io, format = Fmt)
Creates a new instance of Message from the given IO.

#event?
Returns whether the current message is an event.
#payload : String
The message's payload, as a string.
#size : Int32
The size of the message, in bytes.
#to_io(io, format = Fmt)
Writes this instance to the given IO, in the format used by i3.
#to_s(io)
Write a human-friendly representation of this Message to the given IO.
#type : MessageType | ReplyType | EventType
The type of the message.

def self.new(type, payload = "") #

Creates a new Message with the given type and payload.

[View source]

def self.from_io(io, format = Fmt) #

Creates a new instance of Message from the given IO.

Raises an Error on any parsing failure.

[View source]

def event? #

Returns whether the current message is an event.

[View source]

def payload : String #

The message's payload, as a string.

[View source]

def size : Int32 #

The size of the message, in bytes.

[View source]

def to_io(io, format = Fmt) #

Writes this instance to the given IO, in the format used by i3.

[View source]

def to_s(io) #

Write a human-friendly representation of this Message to the given IO.

[View source]

def type : MessageType | ReplyType | EventType #

The type of the message.

[View source]