pretty_diagnostics::Report::Builder Class Reference

Fluent builder for constructing Report instances. More...

#include <report.hpp>

Public Member Functions
Builder &	severity (Severity severity)
	Sets report severity. More...
Builder &	message (std::string message)
	Sets the main diagnostic message. More...
Builder &	code (std::string code)
	Sets an optional error code or identifier. More...
Builder &	label (std::string text, Span span)
	Adds a label to the report. More...
Builder &	note (std::string note)
	Sets an optional note. More...
Builder &	help (std::string help)
	Sets optional help text. More...
Report	build () const
	Builds a complete Report More...

Detailed Description

Fluent builder for constructing Report instances.

Member Function Documentation

build()

Report pretty_diagnostics::Report::Builder::build

(

)

const

Builds a complete Report

Returns

The constructed report

Exceptions

std::exception

If required fields are missing

code()

Builder & pretty_diagnostics::Report::Builder::code

(

std::string

code

)

Sets an optional error code or identifier.

Parameters

code	Error code or identifier

Returns

Reference to this builder

help()

Builder & pretty_diagnostics::Report::Builder::help

(

std::string

help

)

Sets optional help text.

Parameters

help

Help text

Returns

Reference to this builder

label()

Builder & pretty_diagnostics::Report::Builder::label	(	std::string	text,
		Span	span
	)

Adds a label to the report.

Parameters

text	Label message
span	Source span the label refers to

Returns

Reference to this builder

message()

Builder & pretty_diagnostics::Report::Builder::message

(

std::string

message

)

Sets the main diagnostic message.

Parameters

message

Diagnostic message text

Returns

Reference to this builder

note()

Builder & pretty_diagnostics::Report::Builder::note

(

std::string

note

)

Sets an optional note.

Parameters

note

Note text

Returns

Reference to this builder

severity()

Builder & pretty_diagnostics::Report::Builder::severity

(

Severity

severity

)

Sets report severity.

Parameters

severity

Severity to set

Returns

Reference to this builder

---

The documentation for this class was generated from the following file:

• report.hpp