Class: TopSecret::Text::ScanResult

Inherits:

Object

• Object
• TopSecret::Text::ScanResult

Includes:

Mapping

Defined in:

lib/top_secret/text/scan_result.rb

Overview

Holds the result of a scan operation.

Instance Attribute Summary

• #mapping ⇒ Hash readonly

  Mapping of redacted labels to matched values.

Instance Method Summary

• #initialize(mapping) ⇒ ScanResult constructor

  A new instance of ScanResult.

Methods included from Mapping

#categories, #method_missing, #respond_to_missing?, #safe?, #sensitive?

Constructor Details

#initialize(mapping) ⇒ ScanResult

Returns a new instance of ScanResult.

Parameters:

• mapping (Hash) —

  Map of labels to matched values

# File 'lib/top_secret/text/scan_result.rb', line 13

def initialize(mapping)
  @mapping = mapping
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class TopSecret::Mapping

Instance Attribute Details

#mapping ⇒ Hash (readonly)

Returns Mapping of redacted labels to matched values.

Returns:

• (Hash) —

  Mapping of redacted labels to matched values

# File 'lib/top_secret/text/scan_result.rb', line 10

def mapping
  @mapping
end