enum ACP::Protocol::PlanEntryStatus

Defined in:

acp/protocol/enums.cr

Enum Members

Pending = 0

The task has not started yet.

InProgress = 1

The task is currently being worked on.

Completed = 2

The task has been successfully completed.

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) : self #

[View source]
def self.parse(value : String) : PlanEntryStatus #

Parses a wire-format string into a PlanEntryStatus. Raises ArgumentError if the string is not recognized.


[View source]

Class Method Detail

def self.parse?(value : String) : PlanEntryStatus | Nil #

Parses a wire-format string into a PlanEntryStatus. Returns nil if the string is not recognized.


[View source]

Instance Method Detail

def completed? #

Returns true if this enum value equals Completed


[View source]
def in_progress? #

Returns true if this enum value equals InProgress


[View source]
def pending? #

Returns true if this enum value equals Pending


[View source]
def to_json(json : JSON::Builder) : Nil #
Description copied from struct Enum

Serializes this enum member by name.

For non-flags enums, the serialization is a JSON string. The value is the member name (see #to_s) transformed with String#underscore.

enum Stages
  INITIAL
  SECOND_STAGE
end

Stages::INITIAL.to_json      # => %("initial")
Stages::SECOND_STAGE.to_json # => %("second_stage")

For flags enums, the serialization is a JSON array including every flagged member individually serialized in the same way as a member of a non-flags enum. None is serialized as an empty array, All as an array containing all members.

@[Flags]
enum Sides
  LEFT
  RIGHT
end

Sides::LEFT.to_json                  # => %(["left"])
(Sides::LEFT | Sides::RIGHT).to_json # => %(["left","right"])
Sides::All.to_json                   # => %(["left","right"])
Sides::None.to_json                  # => %([])

ValueConverter.to_json offers a different serialization strategy based on the member value.


[View source]
def to_s : String #

Returns the wire-format string for this status.


[View source]