Skip to content

Commit

Permalink
DOCSP-45311: Remove deprecated utf8 types (#78)
Browse files Browse the repository at this point in the history
* DOCSP-45311: Remove deprecated utf8 types

* word

* RR feedback

* EC feedback

* EC last feedback
  • Loading branch information
norareidy authored Nov 22, 2024
1 parent fe69195 commit 1bca700
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions source/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ The v4.0 driver introduces the following breaking changes to the build system:
To include test targets in the "all" target, you must also set the
``BUILD_TESTING`` option to ``ON``.

.. _version-4.0-api-breaking:

API Breaking Changes in v4.0
````````````````````````````

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

- Removes the following deprecated ``utf8`` types and functions that have ``string`` equivalents:

- ``k_utf8`` from the ``bsoncxx::v_noabi::type`` class. Instead, use ``k_string``.
- ``b_utf8`` from the ``bsoncxx::v_noabi::types`` class. Instead, use ``b_string``.
- ``get_utf8()`` from the ``bsoncxx::v_noabi::document::element``, ``bsoncxx::v_noabi::array::element``,
and ``bsoncxx::v_noabi::types::bson_value::view`` classes. Instead, use ``get_string()``.
- ``k_cannot_append_utf8`` from the ``bsoncxx::v_noabi::exception::error_code`` class.
Instead, use ``k_cannot_append_string``.
- ``k_need_element_type_k_utf8`` from the ``bsoncxx::v_noabi::exception::error_code`` class.
Instead, use ``k_need_element_type_k_string``.

- Removes the ``mongocxx::stdx`` namespace. Replace the following
types in your code:

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

- Removes deprecated ``utf8`` functions that have ``string`` equivalents.
For a full list of these changes, see the :ref:`API Breaking Changes <version-4.0-api-breaking>`
section.

.. _version-3.11-breaking-changes:

Version 3.11
Expand Down

0 comments on commit 1bca700

Please sign in to comment.