Skip to content

refactor: changes to aggregate::Repository, event::Store, documentation and more #294

refactor: changes to aggregate::Repository, event::Store, documentation and more

refactor: changes to aggregate::Repository, event::Store, documentation and more #294

GitHub Actions / clippy failed Feb 23, 2024 in 1s

clippy

93 errors

Details

Results

Message level Amount
Internal compiler error 0
Error 93
Warning 0
Note 0
Help 0

Versions

  • rustc 1.78.0-nightly (397937d81 2024-02-22)
  • cargo 1.78.0-nightly (194a60b29 2024-02-21)
  • clippy 0.1.78 (397937d 2024-02-22)

Annotations

Check failure on line 6 in eventually/src/version.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/version.rs:6:10
  |
6 | /// and [crate::event::Store] to implement stream-local ordering to the messages.
  |          ^^^^^^^^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
6 | /// and [`crate::event::Store`] to implement stream-local ordering to the messages.
  |          ~~~~~~~~~~~~~~~~~~~~~

Check failure on line 5 in eventually/src/version.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/version.rs:5:18
  |
5 | /// Used by the [crate::aggregate::Root] to avoid concurrency issues,
  |                  ^^^^^^^^^^^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
5 | /// Used by the [`crate::aggregate::Root`] to avoid concurrency issues,
  |                  ~~~~~~~~~~~~~~~~~~~~~~~~

Check failure on line 94 in eventually/src/serde.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

question mark operator is useless here

error: question mark operator is useless here
  --> eventually/src/serde.rs:92:9
   |
92 | /         Ok(inn
93 | |             .try_into()
94 | |             .map_err(|err| anyhow!("failed to convert type values: {}", err))?)
   | |_______________________________________________________________________________^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_question_mark
note: the lint level is defined here
  --> eventually/src/lib.rs:6:9
   |
6  | #![deny(clippy::all, clippy::pedantic, clippy::cargo)]
   |         ^^^^^^^^^^^
   = note: `#[deny(clippy::needless_question_mark)]` implied by `#[deny(clippy::all)]`
help: try removing question mark and `Ok()`
   |
92 ~         inn
93 +             .try_into()
94 +             .map_err(|err| anyhow!("failed to convert type values: {}", err))
   |

Check failure on line 26 in eventually/src/serde.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function returning `Result` missing `# Errors` section

error: docs for function returning `Result` missing `# Errors` section
  --> eventually/src/serde.rs:26:5
   |
26 |     fn deserialize(&self, data: &[u8]) -> anyhow::Result<T>;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc

Check failure on line 18 in eventually/src/serde.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function returning `Result` missing `# Errors` section

error: docs for function returning `Result` missing `# Errors` section
  --> eventually/src/serde.rs:18:5
   |
18 |     fn serialize(&self, value: T) -> anyhow::Result<Vec<u8>>;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc
   = note: `#[deny(clippy::missing_errors_doc)]` implied by `#[deny(clippy::pedantic)]`

Check failure on line 315 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
   --> eventually/src/event/store.rs:315:68
    |
315 |     /// Returns a [Tracking] instance that decorates the original [event::Store]
    |                                                                    ^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
    |
315 |     /// Returns a [Tracking] instance that decorates the original [`event::Store`]
    |                                                                    ~~~~~~~~~~~~~~

Check failure on line 243 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function which may panic missing `# Panics` section

error: docs for function which may panic missing `# Panics` section
   --> eventually/src/event/store.rs:243:5
    |
243 |     pub fn reset_recorded_events(&self) {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
note: first possible panic found here
   --> eventually/src/event/store.rs:244:9
    |
244 | /         self.events
245 | |             .write()
246 | |             .expect("acquire lock on recorded events list")
    | |___________________________________________________________^
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc

Check failure on line 235 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function which may panic missing `# Panics` section

error: docs for function which may panic missing `# Panics` section
   --> eventually/src/event/store.rs:235:5
    |
235 |     pub fn recorded_events(&self) -> Vec<event::Persisted<StreamId, Event>> {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
note: first possible panic found here
   --> eventually/src/event/store.rs:236:9
    |
236 | /         self.events
237 | |             .read()
238 | |             .expect("acquire lock on recorded events list")
    | |___________________________________________________________^
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc

Check failure on line 210 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
   --> eventually/src/event/store.rs:210:28
    |
210 | /// Decorator type for an [event::Store] implementation that tracks the list of
    |                            ^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
    |
210 | /// Decorator type for an [`event::Store`] implementation that tracks the list of
    |                            ~~~~~~~~~~~~~~

Check failure on line 104 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
   --> eventually/src/event/store.rs:104:30
    |
104 | /// backed by a thread-safe [std::collections::HashMap].
    |                              ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
    |
104 | /// backed by a thread-safe [`std::collections::HashMap`].
    |                              ~~~~~~~~~~~~~~~~~~~~~~~~~~~

Check failure on line 103 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
   --> eventually/src/event/store.rs:103:34
    |
103 | /// In-memory implementation of [event::Store] trait,
    |                                  ^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
    |
103 | /// In-memory implementation of [`event::Store`] trait,
    |                                  ~~~~~~~~~~~~~~

Check failure on line 33 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
  --> eventually/src/event/store.rs:33:43
   |
33 | /// All possible error types returned by [Appender::append].
   |                                           ^^^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
   |
33 | /// All possible error types returned by [`Appender::append`].
   |                                           ~~~~~~~~~~~~~~~~~~

Check failure on line 2 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/event/store.rs:2:54
  |
2 | //! such as the [std::collections::HashMap]'s based [InMemory] Event Store implementation.
  |                                                      ^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
2 | //! such as the [std::collections::HashMap]'s based [`InMemory`] Event Store implementation.
  |                                                      ~~~~~~~~~~

Check failure on line 2 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/event/store.rs:2:18
  |
2 | //! such as the [std::collections::HashMap]'s based [InMemory] Event Store implementation.
  |                  ^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
2 | //! such as the [`std::collections::HashMap`]'s based [InMemory] Event Store implementation.
  |                  ~~~~~~~~~~~~~~~~~~~~~~~~~~~

Check failure on line 1 in eventually/src/event/store.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/event/store.rs:1:38
  |
1 | //! Contains implementations of the [event::Store] trait and connected abstractions,
  |                                      ^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
1 | //! Contains implementations of the [`event::Store`] trait and connected abstractions,
  |                                      ~~~~~~~~~~~~~~

Check failure on line 245 in eventually/src/aggregate/mod.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
   --> eventually/src/aggregate/mod.rs:245:54
    |
245 | /// List of possible errors that can be returned by [Root::rehydrate_async].
    |                                                      ^^^^^^^^^^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
    |
245 | /// List of possible errors that can be returned by [`Root::rehydrate_async`].
    |                                                      ~~~~~~~~~~~~~~~~~~~~~~~

Check failure on line 88 in eventually/src/aggregate/test.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function which may panic missing `# Panics` section

error: docs for function which may panic missing `# Panics` section
   --> eventually/src/aggregate/test.rs:85:5
    |
85  | /     pub fn when<R, F, Err>(self, f: F) -> ScenarioWhen<T, R, impl Fn() -> Result<R, Err>, Err>
86  | |     where
87  | |         R: From<Root<T>>,
88  | |         F: Fn(&mut R) -> Result<(), Err>,
    | |_________________________________________^
    |
note: first possible panic found here
   --> eventually/src/aggregate/test.rs:97:35
    |
97  |                   let mut root: R = Root::<T>::rehydrate(events.iter().cloned())
    |  ___________________________________^
98  | |                     .expect(
99  | |                         "no error is expected when applying domain events from a 'given' clause",
100 | |                     )
101 | |                     .expect("an aggregate root instance is expected, but none was produced")
    | |____________________________________________________________________________________________^
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc
    = note: `#[deny(clippy::missing_panics_doc)]` implied by `#[deny(clippy::pedantic)]`

Check failure on line 83 in eventually/src/aggregate/test.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
  --> eventually/src/aggregate/test.rs:83:30
   |
83 |     /// current state using [Scenario::given].
   |                              ^^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
   |
83 |     /// current state using [`Scenario::given`].
   |                              ~~~~~~~~~~~~~~~~~

Check failure on line 39 in eventually/src/aggregate/repository.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
  --> eventually/src/aggregate/repository.rs:39:38
   |
39 | /// All possible errors returned by [Saver::save].
   |                                      ^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
   |
39 | /// All possible errors returned by [`Saver::save`].
   |                                      ~~~~~~~~~~~~~

Check failure on line 16 in eventually/src/aggregate/repository.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
  --> eventually/src/aggregate/repository.rs:16:38
   |
16 | /// All possible errors returned by [Getter::get].
   |                                      ^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
   |
16 | /// All possible errors returned by [`Getter::get`].
   |                                      ~~~~~~~~~~~~~

Check failure on line 5 in eventually/src/aggregate/repository.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/aggregate/repository.rs:5:21
  |
5 | //! take a look at [EventSourced].
  |                     ^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
note: the lint level is defined here
 --> eventually/src/lib.rs:6:22
  |
6 | #![deny(clippy::all, clippy::pedantic, clippy::cargo)]
  |                      ^^^^^^^^^^^^^^^^
  = note: `#[deny(clippy::doc_markdown)]` implied by `#[deny(clippy::pedantic)]`
help: try
  |
5 | //! take a look at [`EventSourced`].
  |                     ~~~~~~~~~~~~~~

Check failure on line 6 in eventually/src/version.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/version.rs:6:10
  |
6 | /// and [crate::event::Store] to implement stream-local ordering to the messages.
  |          ^^^^^^^^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
6 | /// and [`crate::event::Store`] to implement stream-local ordering to the messages.
  |          ~~~~~~~~~~~~~~~~~~~~~

Check failure on line 5 in eventually/src/version.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

item in documentation is missing backticks

error: item in documentation is missing backticks
 --> eventually/src/version.rs:5:18
  |
5 | /// Used by the [crate::aggregate::Root] to avoid concurrency issues,
  |                  ^^^^^^^^^^^^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
  |
5 | /// Used by the [`crate::aggregate::Root`] to avoid concurrency issues,
  |                  ~~~~~~~~~~~~~~~~~~~~~~~~

Check failure on line 94 in eventually/src/serde.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

question mark operator is useless here

error: question mark operator is useless here
  --> eventually/src/serde.rs:92:9
   |
92 | /         Ok(inn
93 | |             .try_into()
94 | |             .map_err(|err| anyhow!("failed to convert type values: {}", err))?)
   | |_______________________________________________________________________________^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_question_mark
note: the lint level is defined here
  --> eventually/src/lib.rs:6:9
   |
6  | #![deny(clippy::all, clippy::pedantic, clippy::cargo)]
   |         ^^^^^^^^^^^
   = note: `#[deny(clippy::needless_question_mark)]` implied by `#[deny(clippy::all)]`
help: try removing question mark and `Ok()`
   |
92 ~         inn
93 +             .try_into()
94 +             .map_err(|err| anyhow!("failed to convert type values: {}", err))
   |

Check failure on line 26 in eventually/src/serde.rs

See this annotation in the file changed.

@github-actions github-actions / clippy

docs for function returning `Result` missing `# Errors` section

error: docs for function returning `Result` missing `# Errors` section
  --> eventually/src/serde.rs:26:5
   |
26 |     fn deserialize(&self, data: &[u8]) -> anyhow::Result<T>;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc