Skip to content

Commit 67fcab1

Browse files
committed
Fixing broken doc links
1 parent 7b82bcf commit 67fcab1

File tree

8 files changed

+30
-14
lines changed

8 files changed

+30
-14
lines changed

.rustme/client-docs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ QUIC is a new protocol built atop UDP. It is designed to operate more
77
reliably than TCP, and features TLS built-in at the protocol level.
88
WebSockets are an established protocol built atop TCP and HTTP.
99

10-
[`Client`]($client-type$) provides access to BonsaiDb by implementing the
11-
[`StorageConnection`]($storage-connection-trait$) trait.
10+
[`BlockingClient`]($client-type$) provides access to BonsaiDb by implementing
11+
the [`StorageConnection`]($storage-connection-trait$) trait.
12+
[`AsyncClient`]($async-client-type$) provides access to BonsaiDb by implementing
13+
the [`AsyncStorageConnection`]($async-storage-connection-trait$) trait.
1214

1315
## Minimum Supported Rust Version (MSRV)
1416

.rustme/config.ron

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,25 @@ Configuration(
7777
release: "https://docs.rs/bonsaidb",
7878
),
7979
"client-type": (
80-
default: "https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.Client.html",
81-
release: "https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.Client.html",
82-
for_docs: "crate::Client",
80+
default: "https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.BlockingClient.html",
81+
release: "https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.BlockingClient.html",
82+
for_docs: "crate::BlockingClient",
83+
),
84+
"async-client-type": (
85+
default: "https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.AsyncClient.html",
86+
release: "https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.AsyncClient.html",
87+
for_docs: "crate::AsyncClient",
8388
),
8489
"storage-connection-trait": (
8590
default: "https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html",
8691
release: "https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html",
8792
for_docs: "::bonsaidb_core::connection::StorageConnection",
8893
),
94+
"async-storage-connection-trait": (
95+
default: "https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.AsyncStorageConnection.html",
96+
release: "https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.AsyncStorageConnection.html",
97+
for_docs: "::bonsaidb_core::connection::AsyncStorageConnection",
98+
),
8999
"schema-trait": (
90100
default: "https://dev.bonsaidb.io/main/docs/bonsaidb/core/schema/trait.Schema.html",
91101
release: "https://docs.rs/bonsaidb-core/*/bonsaidb_core/schema/trait.Schema.html",

crates/bonsaidb-client/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ QUIC is a new protocol built atop UDP. It is designed to operate more
99
reliably than TCP, and features TLS built-in at the protocol level.
1010
WebSockets are an established protocol built atop TCP and HTTP.
1111

12-
[`Client`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.Client.html) provides access to BonsaiDb by implementing the
13-
[`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html) trait.
12+
[`BlockingClient`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.BlockingClient.html) provides access to BonsaiDb by implementing
13+
the [`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html) trait.
14+
[`AsyncClient`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.AsyncClient.html) provides access to BonsaiDb by implementing
15+
the [`AsyncStorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.AsyncStorageConnection.html) trait.
1416

1517
## Minimum Supported Rust Version (MSRV)
1618

crates/bonsaidb-client/src/.crate-docs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ QUIC is a new protocol built atop UDP. It is designed to operate more
77
reliably than TCP, and features TLS built-in at the protocol level.
88
WebSockets are an established protocol built atop TCP and HTTP.
99

10-
[`Client`](crate::Client) provides access to BonsaiDb by implementing the
11-
[`StorageConnection`](::bonsaidb_core::connection::StorageConnection) trait.
10+
[`BlockingClient`](crate::BlockingClient) provides access to BonsaiDb by implementing
11+
the [`StorageConnection`](::bonsaidb_core::connection::StorageConnection) trait.
12+
[`AsyncClient`](crate::AsyncClient) provides access to BonsaiDb by implementing
13+
the [`AsyncStorageConnection`](::bonsaidb_core::connection::AsyncStorageConnection) trait.
1214

1315
## Minimum Supported Rust Version (MSRV)
1416

crates/bonsaidb-client/src/builder.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pub struct Async;
2020
#[cfg(not(target_arch = "wasm32"))]
2121
pub struct Blocking;
2222

23-
/// Builds a new [`Client`] with custom settings.
23+
/// Builder for a [`BlockingClient`] or an [`AsyncClient`].
2424
#[must_use]
2525
pub struct Builder<AsyncMode> {
2626
url: Url,

crates/bonsaidb-client/src/error.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use bonsaidb_core::arc_bytes::serde::Bytes;
22
use bonsaidb_core::schema::Name;
33

4-
/// Errors related to working with [`Client`](crate::Client)
4+
/// Errors related to working with the BonsaiDb client.
55
#[derive(thiserror::Error, Debug)]
66
pub enum Error {
77
#[cfg(feature = "websockets")]

crates/bonsaidb-server/src/server/connected_client.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ impl<B: Backend> ConnectedClient<B> {
109109
sessions.get(&session_id).map(|data| data.session.clone())
110110
}
111111

112-
/// Returns a collection of all active [`Sesssion`]s for this client.
112+
/// Returns a collection of all active [`Session`]s for this client.
113113
#[must_use]
114114
pub fn all_sessions<C: FromIterator<Session>>(&self) -> C {
115115
let sessions = self.data.sessions.read();

crates/bonsaidb/src/any_connection.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use derive_where::derive_where;
1919
pub enum AnyServerConnection<B: Backend> {
2020
/// A local server.
2121
Local(CustomServer<B>),
22-
/// A server accessed with a [`Client`].
22+
/// A server accessed with an [`AsyncClient`].
2323
Networked(AsyncClient),
2424
}
2525

@@ -238,7 +238,7 @@ impl<B: Backend> AsyncStorageConnection for AnyServerConnection<B> {
238238
pub enum AnyDatabase<B: Backend = NoBackend> {
239239
/// A local database.
240240
Local(ServerDatabase<B>),
241-
/// A networked database accessed with a [`Client`].
241+
/// A networked database accessed with an [`AsyncRemoteDatabase`].
242242
Networked(AsyncRemoteDatabase),
243243
}
244244

0 commit comments

Comments
 (0)