module Ronin::Support::CLI::Printing

Printing methods.

@since 1.0.0

Attributes

debug[W]

Enables or disables debug mode.

@api semipublic

Public Class Methods

debug=(debug_mode) click to toggle source

Sets the debug mode.

@param [Boolean] debug_mode

The new debug mode.

@return [Boolean]

The new debug mode.

@api semipublic

# File lib/ronin/support/cli/printing.rb, line 55
def self.debug=(debug_mode)
  @debug = debug_mode
end
debug?() click to toggle source

The current debug mode.

@return [Boolean]

The new debug mode.

@api semipublic

# File lib/ronin/support/cli/printing.rb, line 40
def self.debug?
  @debug
end

Public Instance Methods

debug?() click to toggle source

Determines if debug mode has been enabled.

@return [Boolean]

@api public

# File lib/ronin/support/cli/printing.rb, line 71
def debug?
  @debug || Printing.debug?
end
print_bad(message)
Alias for: print_negative
print_debug(message) click to toggle source

Prints a debug message.

@param [String] message

The message to print.

@return [Boolean]

Specifies whether the messages were successfully printed.

@example

print_debug "debug information here"
# [?] debug information here

@note

Will return `false` unless verbose printing is enabled.

@api public

print_error(message) click to toggle source

Prints an error message.

@param [String] message

The message to print.

@return [Boolean]

Specifies whether the messages were successfully printed.

@example

print_error "Could not connect!"
# [!] Could not connect!

@api public

print_failure(message)
Alias for: print_negative
print_good(message)
Alias for: print_positive
print_info(message) click to toggle source

Prints an info message.

@param [String] message

The message to print.

@return [Boolean]

Specifies whether the messages were successfully printed.

@example

print_info "Connecting ..."
# [*] Connecting ...

@api public

Also aliased as: print_status
print_negative(message) click to toggle source

Prints a negative message.

@param [String] message

The message to print.

@return [Boolean]

Specifies whether the messages were successfully printed.

@example

print_negative "Password failed!"
# [-] Password failed!

@api public

@since 1.0.0

Also aliased as: print_failure, print_bad
print_positive(message) click to toggle source

Prints a positive message.

@param [String] message

The message to print.

@return [Boolean]

Specifies whether the messages were successfully printed.

@example

print_positive "Password worked!"
# [+] Password worked!

@api public

@since 1.0.0

Also aliased as: print_success, print_good
print_status(message)
Alias for: print_info
print_success(message)
Alias for: print_positive
print_warning(message) click to toggle source

Prints a warning message.

@param [String] message

The message to print.

@return [Boolean]

Specifies whether the messages were successfully printed.

@example

print_warning "Rate limit exceeded, slowing down scanning."
# [~] Rate limit exceeded, slowing down scanning.

@api public