Skip to content

Commit 09e93e2

Browse files
RUST-999 Link web framework examples/documentation in README.md (#683)
Co-authored-by: Patrick Freed <[email protected]>
1 parent 63e9973 commit 09e93e2

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ For more detailed documentation, see [the manual](https://mongodb.github.io/mong
1919
- [Inserting documents into a collection](#inserting-documents-into-a-collection)
2020
- [Finding documents in a collection](#finding-documents-in-a-collection)
2121
- [Using the sync API](#using-the-sync-api)
22+
- [Web Framework Examples](#web-framework-examples)
2223
- [Platforms](#platforms)
2324
- [Note on connecting to Atlas deployments](#note-on-connecting-to-atlas-deployments)
2425
- [Windows DNS note](#windows-dns-note)
@@ -235,6 +236,13 @@ for result in cursor {
235236
}
236237
```
237238

239+
## Web Framework Examples
240+
### Actix
241+
The driver can be used easily with the Actix web framework by storing a `Client` in Actix application data. A full example application for using MongoDB with Actix can be found [here](https://github.com/actix/examples/tree/master/databases/mongodb).
242+
243+
### Rocket
244+
The Rocket web framework provides built-in support for MongoDB via the Rust driver. The documentation for the [`rocket_db_pools`](https://api.rocket.rs/v0.5-rc/rocket_db_pools/index.html) crate contains instructions for using MongoDB with your Rocket application.
245+
238246
## Platforms
239247

240248
The driver tests against Linux, MacOS, and Windows in CI.

manual/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Sessions and Transactions]()
1111
- [Change Streams]()
1212
- [Monitoring]()
13+
- [Web Framework Examples](web_framework_examples.md)
1314

1415
# Development
1516

manual/src/web_framework_examples.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Web Framework Examples
2+
3+
## Actix
4+
The driver can be used easily with the Actix web framework by storing a `Client` in Actix application data. A full example application for using MongoDB with Actix can be found [here](https://github.com/actix/examples/tree/master/databases/mongodb).
5+
6+
## Rocket
7+
The Rocket web framework provides built-in support for MongoDB via the Rust driver. The documentation for the [`rocket_db_pools`](https://api.rocket.rs/v0.5-rc/rocket_db_pools/index.html) crate contains instructions for using MongoDB with your Rocket application.

0 commit comments

Comments
 (0)