File: avoid-const-or-ref-data-members.rst

package info (click to toggle)
llvm-toolchain-19 1%3A19.1.7-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,998,520 kB
  • sloc: cpp: 6,951,680; ansic: 1,486,157; asm: 913,598; python: 232,024; f90: 80,126; objc: 75,281; lisp: 37,276; pascal: 16,990; sh: 10,009; ml: 5,058; perl: 4,724; awk: 3,523; makefile: 3,167; javascript: 2,504; xml: 892; fortran: 664; cs: 573
file content (51 lines) | stat: -rw-r--r-- 1,177 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.. title:: clang-tidy - cppcoreguidelines-avoid-const-or-ref-data-members

cppcoreguidelines-avoid-const-or-ref-data-members
=================================================

This check warns when structs or classes that are copyable or movable, and have
const-qualified or reference (lvalue or rvalue) data members. Having such
members is rarely useful, and makes the class only copy-constructible but not
copy-assignable.

Examples:

.. code-block:: c++

  // Bad, const-qualified member
  struct Const {
    const int x;
  }

  // Good:
  class Foo {
   public:
    int get() const { return x; }
   private:
    int x;
  };

  // Bad, lvalue reference member
  struct Ref {
    int& x;
  };

  // Good:
  struct Foo {
    int* x;
    std::unique_ptr<int> x;
    std::shared_ptr<int> x;
    gsl::not_null<int*> x;
  };

  // Bad, rvalue reference member
  struct RefRef {
    int&& x;
  };

This check implements `C.12
<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rc-constref>`_
from the C++ Core Guidelines.

Further reading:
`Data members: Never const <https://quuxplusone.github.io/blog/2022/01/23/dont-const-all-the-things/#data-members-never-const>`_.