Class: Slamdown::Conversion::Rendering::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/slamdown/conversion/rendering/result.rb

Overview

Carries one rendered document together with node-local failures contained during traversal.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(output, diagnostics) ⇒ Result

Returns a new instance of Result.

Raises:

  • (ArgumentError)


11
12
13
14
15
16
17
18
# File 'lib/slamdown/conversion/rendering/result.rb', line 11

def initialize(output, diagnostics)
	raise ArgumentError, "output must be a string" unless output.is_a?(String)
	raise ArgumentError, "diagnostics must contain only Slamdown diagnostics" unless diagnostics.is_a?(Array) && diagnostics.all? { |diagnostic| diagnostic.is_a?(Diagnostic) }

	@output = output.dup.freeze
	@diagnostics = diagnostics.dup.freeze
	freeze
end

Instance Attribute Details

#diagnosticsObject (readonly)

Returns the value of attribute diagnostics.



9
10
11
# File 'lib/slamdown/conversion/rendering/result.rb', line 9

def diagnostics
  @diagnostics
end

#outputObject (readonly)

Returns the value of attribute output.



9
10
11
# File 'lib/slamdown/conversion/rendering/result.rb', line 9

def output
  @output
end