theS1LV3R
42fda1eda5
All checks were successful
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 32s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 1m36s
Checks / Prek / Pre-commit & Formatting (push) Successful in 32s
Checks / Prek / Clippy and Cargo Tests (push) Successful in 1m39s
And misc improvements to the lib.rs doc comment.
52 lines
2.8 KiB
Markdown
52 lines
2.8 KiB
Markdown
# `resolvematrix`
|
|
|
|
[](https://deps.rs/repo/gitea/forgejo.ellis.link/continuwuation/resolvematrix)
|
|
[](https://crates.io/crates/resolvematrix)
|
|
[](https://docs.rs/resolvematrix)
|
|
[](https://forgejo.ellis.link/continuwuation/resolvematrix/src/branch/main/LICENSE)
|
|
|
|
[](https://forgejo.ellis.link/continuwuation/resolvematrix) [](https://forgejo.ellis.link/continuwuation/resolvematrix/issues?state=open) [](https://forgejo.ellis.link/continuwuation/resolvematrix/pulls?state=open)
|
|
[](https://github.com/continuwuity/resolvematrix)
|
|
|
|
`resolvematrix` is a Rust library providing the ability to resolve Matrix server-to-server endpoints from the server name.
|
|
It conforms to the [Server discovery chapter of the Matrix specification](https://spec.matrix.org/v1.18/server-server-api/#resolving-server-names).
|
|
|
|
The library is tested against the https://resolvematrix.dev suite and other live Matrix servers.
|
|
|
|
This library depends on `hickory-resolver`, `reqwest`, `serde` and (indirectly) `tokio`.
|
|
|
|
## Usage
|
|
|
|
`cargo add resolvematrix`
|
|
|
|
### Example
|
|
|
|
```rust
|
|
use resolvematrix::server::{MatrixResolver, MatrixResolverBuilder};
|
|
|
|
// Create a new resolver
|
|
let resolver = Arc::new(MatrixResolver::new()?);
|
|
// Or to use custom options:
|
|
// MatrixResolverBuilder::new().cache_ttl(Duration::from_secs(10)).build()?
|
|
|
|
// Resolve a server name
|
|
let server_name = "matrix.org";
|
|
let resolution = resolver.resolve_server(server_name).await?;
|
|
eprintln!("Resolved server: {resolution:?}");
|
|
|
|
let client = resolver.create_client().unwrap();
|
|
let url = format!("{}/_matrix/federation/v1/version", resolution.base_url());
|
|
let response = client.get(&url).send().await;
|
|
|
|
```
|
|
|
|
For more examples, see the [examples](https://forgejo.ellis.link/continuwuation/resolvematrix/src/branch/main/examples) directory.
|
|
|
|
## Contributing
|
|
|
|
Resolvematrix is part of the [Continuwuity](https://continuwuity.org) project. Please see the
|
|
[Contributing guide](https://continuwuity.org/development/contributing) before submitting a pull request.
|
|
|
|
## Code of Conduct
|
|
|
|
Contributors are expected to follow the [Continuwuity Community Guidelines](https://continuwuity.org/community/guidelines).
|