Skip to content

Add name parameter and box.error.is function description to box.error. #5112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 22, 2025
Merged

Add name parameter and box.error.is function description to box.error. #5112

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
908ab26
Add description of the ``name`` parameter
AArdeev May 14, 2025
c170d0a
Add description of box.error.is function
AArdeev May 14, 2025
6721644
Update by comments
AArdeev May 14, 2025
cddd939
Fix by comment and fix typo
AArdeev May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/reference/reference_lua/box_error.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ Below is a list of ``box.error`` functions and related objects.
- Set the specified error as the last system error explicitly

* - :doc:`./box_error/is`
- Verify whether the specified argument is an error
- Verify whether the specified argument is an error cdata object

* - :doc:`./box_error/error_object`
- An object that defines an error
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/reference_lua/box_error/error_object.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,6 @@ error_object

**Since:** :doc:`3.1.0 </release/3.1.0>`

Returns the name of the error used at creation.
Returns the name of the error.


25 changes: 13 additions & 12 deletions doc/reference/reference_lua/box_error/is.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,26 @@
box.error.is()
===============================================================================

.. function:: box.error.is(object_name)
.. function:: box.error.is(object)

**Since:** :doc:`3.2.0 </release/3.2.0>`

The ``box.error.is`` function allows verify whether the specified argument is an error.
The ``box.error.is`` function allows verify whether the specified argument is an error cdata object.

:param object_name object_name: the subject of the request
:param object object: the name of the othe object to be verified.

**Return type:**
boolean

**Example**

.. code-block:: lua
tarantool> box.error.is(box.error.new(box.error.UNKNOWN))
---
- true
...
tarantool> box.error.is('foo')
---
- false
...
.. code-block:: lua

tarantool> box.error.is(box.error.new(box.error.UNKNOWN))
---
- true
...
tarantool> box.error.is('foo')
---
- false
...