asserts.fail

Force an assertion failure.

📝Syntax

asserts.fail()
asserts.fail(message)
[res, msg] = asserts.fail(message)

📥Input Arguments

Parameter	Description
message	Optional custom failure message.

📤Output Arguments

Parameter	Description
res	true if the assertion passes, false otherwise.
msg	assertion failure message, empty on success.

📄Description

Use this assertion to mark an execution path that must not be reached.

With outputs, no error is raised and res is false.

💡Examples

Capture a forced failure

[res, msg] = asserts.fail('unreachable branch');

Raise a forced failure

try; asserts.fail('unreachable branch'); catch ME; disp(ME.message); end

🔗See Also

🕔Version History

Version	Description
2.0.0	initial version