struct ACP::Protocol::ErrorUpdate

Overview

Reports a non-fatal error to the client.

NOTE Not part of the ACP spec.

Included Modules

Defined in:

acp/protocol/updates.cr

Constructors

Instance Method Summary

Instance methods inherited from struct ACP::Protocol::SessionUpdate

session_update : String session_update, session_update=(session_update : String) session_update=, type : String type

Constructor methods inherited from struct ACP::Protocol::SessionUpdate

new(pull : JSON::PullParser) new

Constructor Detail

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

Reports a non-fatal error to the client.

NOTE Not part of the ACP spec.


[View source]
def self.new(message : String, code : Int32 | Nil = nil, detail : String | Nil = nil, meta : Hash(String, JSON::Any) | Nil = nil) #

[View source]

Instance Method Detail

def code : Int32 | Nil #

Optional error code for programmatic handling.


[View source]
def code=(code : Int32 | Nil) #

Optional error code for programmatic handling.


[View source]
def detail : String | Nil #

Optional additional detail or stack trace.


[View source]
def detail=(detail : String | Nil) #

Optional additional detail or stack trace.


[View source]
def message : String #

Error message text.


[View source]
def message=(message : String) #

Error message text.


[View source]
def meta : Hash(String, JSON::Any) | Nil #

Extension metadata.


[View source]
def meta=(meta : Hash(String, JSON::Any) | Nil) #

Extension metadata.


[View source]