Skip to content

Commit

Permalink
Doc: get_snapshot_builder() is a method of RaftStateMachine
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveLauC authored and drmingdrmer committed Apr 26, 2024
1 parent ba61931 commit 554546b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion openraft/src/docs/getting_started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Most of the APIs are quite straightforward, except two indirect APIs:
And [`RaftLogStorage::get_log_state()`][`get_log_state()`] get latest log state from the storage;
- Build a snapshot from the local state machine needs to be done in two steps:
- [`RaftLogStorage::get_snapshot_builder() -> Self::SnapshotBuilder`][`get_snapshot_builder()`],
- [`RaftStateMachine::get_snapshot_builder() -> Self::SnapshotBuilder`][`get_snapshot_builder()`],
- [`RaftSnapshotBuilder::build_snapshot() -> Result<Snapshot>`][`build_snapshot()`],
Expand Down

0 comments on commit 554546b

Please sign in to comment.