Class: SynchronisedMigration::Result

Inherits:

Object

• Object
• SynchronisedMigration::Result

Defined in:

lib/synchronised_migration/result.rb

Instance Attribute Summary

• #error ⇒ Object

  Returns the value of attribute error.

Class Method Summary

• .fail(error) ⇒ Object
• .ok ⇒ Object

Instance Method Summary

• #initialize(error = nil) ⇒ Result constructor

  A new instance of Result.

• #success? ⇒ Boolean

Constructor Details

#initialize(error = nil) ⇒ Result

Returns a new instance of Result.

# File 'lib/synchronised_migration/result.rb', line 6

def initialize(error = nil)
  @error = error
end

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.

# File 'lib/synchronised_migration/result.rb', line 4

def error
  @error
end

Class Method Details

.fail(error) ⇒ Object

# File 'lib/synchronised_migration/result.rb', line 18

def self.fail(error)
  self.new error
end

.ok ⇒ Object

# File 'lib/synchronised_migration/result.rb', line 14

def self.ok
  self.new
end

Instance Method Details

#success? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/synchronised_migration/result.rb', line 10

def success?
  error.nil?
end