Skip to content

Commit 1bca700

Browse files
authored
DOCSP-45311: Remove deprecated utf8 types (#78)
* DOCSP-45311: Remove deprecated utf8 types * word * RR feedback * EC feedback * EC last feedback
1 parent fe69195 commit 1bca700

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

source/upgrade.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,8 @@ The v4.0 driver introduces the following breaking changes to the build system:
149149
To include test targets in the "all" target, you must also set the
150150
``BUILD_TESTING`` option to ``ON``.
151151

152+
.. _version-4.0-api-breaking:
153+
152154
API Breaking Changes in v4.0
153155
````````````````````````````
154156

@@ -159,6 +161,17 @@ The v4.0 driver introduces the following breaking changes to the API:
159161
library equivalents. For context, see the :ref:`Build System Breaking Changes
160162
<version-4.0-build-system-breaking>` section.
161163

164+
- Removes the following deprecated ``utf8`` types and functions that have ``string`` equivalents:
165+
166+
- ``k_utf8`` from the ``bsoncxx::v_noabi::type`` class. Instead, use ``k_string``.
167+
- ``b_utf8`` from the ``bsoncxx::v_noabi::types`` class. Instead, use ``b_string``.
168+
- ``get_utf8()`` from the ``bsoncxx::v_noabi::document::element``, ``bsoncxx::v_noabi::array::element``,
169+
and ``bsoncxx::v_noabi::types::bson_value::view`` classes. Instead, use ``get_string()``.
170+
- ``k_cannot_append_utf8`` from the ``bsoncxx::v_noabi::exception::error_code`` class.
171+
Instead, use ``k_cannot_append_string``.
172+
- ``k_need_element_type_k_utf8`` from the ``bsoncxx::v_noabi::exception::error_code`` class.
173+
Instead, use ``k_need_element_type_k_string``.
174+
162175
- Removes the ``mongocxx::stdx`` namespace. Replace the following
163176
types in your code:
164177

@@ -184,6 +197,10 @@ The v4.0 driver introduces the following breaking changes to the ABI:
184197
library equivalents. For context, see the :ref:`Build System Breaking Changes
185198
<version-4.0-build-system-breaking>` section.
186199

200+
- Removes deprecated ``utf8`` functions that have ``string`` equivalents.
201+
For a full list of these changes, see the :ref:`API Breaking Changes <version-4.0-api-breaking>`
202+
section.
203+
187204
.. _version-3.11-breaking-changes:
188205

189206
Version 3.11

0 commit comments

Comments
 (0)