Module: Lich::Common::ShutdownResultPredicates

Included in:

BestEffortShutdownCleanup::Result, OrderlyShutdown::Result

Defined in:

documented/common/shutdown_result_predicates.rb

Overview

Shared predicates for shutdown result structs.

Instance Method Summary

• #completed? ⇒ Boolean

  Whether every required shutdown step completed.

• #failed? ⇒ Boolean

  Whether any shutdown step raised.

• #scripts_drained? ⇒ Boolean

  Whether script shutdown ran and left no registered scripts.

• #vars_saved? ⇒ Boolean

  Whether local script settings were saved.

Instance Method Details

#completed? ⇒ Boolean

Returns whether every required shutdown step completed.

Returns:

• (Boolean) —

  whether every required shutdown step completed

# File 'documented/common/shutdown_result_predicates.rb', line 10

def completed?
  completed
end

#failed? ⇒ Boolean

Returns whether any shutdown step raised.

Returns:

• (Boolean) —

  whether any shutdown step raised

# File 'documented/common/shutdown_result_predicates.rb', line 15

def failed?
  !failures.empty?
end

#scripts_drained? ⇒ Boolean

Returns whether script shutdown ran and left no registered scripts.

Returns:

• (Boolean) —

  whether script shutdown ran and left no registered scripts

# File 'documented/common/shutdown_result_predicates.rb', line 20

def scripts_drained?
  scripts_drained
end

#vars_saved? ⇒ Boolean

Returns whether local script settings were saved.

Returns:

• (Boolean) —

  whether local script settings were saved

# File 'documented/common/shutdown_result_predicates.rb', line 25

def vars_saved?
  vars_saved
end