Class: Gruf::Errors::Field

Inherits:

Object

• Object
• Gruf::Errors::Field

Defined in:

lib/gruf/errors/field.rb

Overview

Represents a field-specific error

Instance Attribute Summary

• #error_code ⇒ Symbol readonly

  The application error code for the field, e.g.

• #field_name ⇒ Symbol readonly

  The name of the field as a Symbol.

• #message ⇒ String readonly

  The error message for the field, e.g.

Instance Method Summary

• #initialize(field_name, error_code, message = '') ⇒ Field constructor

  A new instance of Field.

• #to_h ⇒ Hash

  Return the field error represented as a hash.

Constructor Details

#initialize(field_name, error_code, message = '') ⇒ Field

# File 'lib/gruf/errors/field.rb', line 36

def initialize(field_name, error_code, message = '')
  @field_name = field_name
  @error_code = error_code
  @message = message
end

Instance Attribute Details

#error_code ⇒ Symbol (readonly)

# File 'lib/gruf/errors/field.rb', line 27

def error_code
  @error_code
end

#field_name ⇒ Symbol (readonly)

# File 'lib/gruf/errors/field.rb', line 25

def field_name
  @field_name
end

#message ⇒ String (readonly)

# File 'lib/gruf/errors/field.rb', line 29

def message
  @message
end

Instance Method Details

#to_h ⇒ Hash

Return the field error represented as a hash

# File 'lib/gruf/errors/field.rb', line 47

def to_h
  {
    field_name: field_name,
    error_code: error_code,
    message: message
  }
end