Skip to content

Commit e7fa999

Browse files
committed
fix: resolve broken rustdoc intra-doc links
- stygian-proxy: use full path for RotationStrategy in manager.rs - stygian-proxy: use full path for ProxyError::AllProxiesUnhealthy in strategy/mod.rs - stygian-proxy: qualify async_trait link as macro@ in storage/mod.rs - stygian-graph: use full crate paths for RestApiAdapter in openapi.rs module docs - stygian-graph: use full crate paths for SigningPort, NoopSigningAdapter, HttpSigningAdapter in signing.rs module docs
1 parent 1536563 commit e7fa999

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

crates/stygian-graph/src/adapters/openapi.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
//! 1. Fetches and parses the spec, caching it for the lifetime of the adapter.
77
//! 2. Resolves the target operation by `operationId` or `"METHOD /path"`.
88
//! 3. Binds `params.args` to path parameters, query parameters, and request body.
9-
//! 4. Delegates the concrete HTTP call to the inner [`RestApiAdapter`].
9+
//! 4. Delegates the concrete HTTP call to the inner [`crate::adapters::rest_api::RestApiAdapter`].
1010
//!
1111
//! An optional proactive rate limit (`params.rate_limit`) is enforced before
12-
//! each request; reactive 429 handling is inherited from [`RestApiAdapter`].
12+
//! each request; reactive 429 handling is inherited from [`crate::adapters::rest_api::RestApiAdapter`].
1313
//!
1414
//! # `ServiceInput` contract
1515
//!
@@ -18,7 +18,7 @@
1818
//! | `url` | string | URL of the OpenAPI spec (JSON or YAML) |
1919
//! | `params.operation` | string | `operationId` **or** `"METHOD /path"` |
2020
//! | `params.args` | object | Path / query / body args (merged) |
21-
//! | `params.auth` | object | Same shape as [`RestApiAdapter`] |
21+
//! | `params.auth` | object | Same shape as [`crate::adapters::rest_api::RestApiAdapter`] |
2222
//! | `params.server.url` | string | Override the spec's `servers[0].url` |
2323
//! | `params.rate_limit` | object | Optional proactive throttle |
2424
//!

crates/stygian-graph/src/adapters/signing.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
//! Request signing adapters.
22
//!
3-
//! Provides concrete [`SigningPort`] implementations:
3+
//! Provides concrete [`crate::ports::signing::SigningPort`] implementations:
44
//!
55
//! | Adapter | Use case |
66
//! |---|---|
7-
//! | [`NoopSigningAdapter`] | Testing / no-op passthrough |
8-
//! | [`HttpSigningAdapter`] | Delegate to any external signing sidecar over HTTP |
7+
//! | [`crate::adapters::signing::NoopSigningAdapter`] | Testing / no-op passthrough |
8+
//! | [`crate::adapters::signing::HttpSigningAdapter`] | Delegate to any external signing sidecar over HTTP |
99
//!
1010
//! # Frida RPC bridge example
1111
//!
@@ -22,7 +22,7 @@
2222
//!
2323
//! # AWS Signature V4 / custom HMAC
2424
//!
25-
//! Implement [`SigningPort`] directly, or point [`HttpSigningAdapter`] at a
25+
//! Implement [`crate::ports::signing::SigningPort`] directly, or point [`crate::adapters::signing::HttpSigningAdapter`] at a
2626
//! lightweight signing sidecar that handles key material and algorithm details.
2727
2828
use std::collections::HashMap;

crates/stygian-proxy/src/manager.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ impl ProxyManager {
246246
///
247247
/// Builds [`ProxyCandidate`] entries from current storage, consulting the
248248
/// health map and each proxy's circuit breaker to set the `healthy` flag.
249-
/// Delegates selection to the configured [`RotationStrategy`].
249+
/// Delegates selection to the configured [`crate::strategy::RotationStrategy`].
250250
pub async fn acquire_proxy(&self) -> ProxyResult<ProxyHandle> {
251251
let with_metrics = self.storage.list_with_metrics().await?;
252252
if with_metrics.is_empty() {

crates/stygian-proxy/src/storage/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use crate::types::{Proxy, ProxyRecord};
99
/// Abstract storage interface for persisting and querying proxy records.
1010
///
1111
/// Implementors must be `Send + Sync + 'static` to support concurrent access
12-
/// across async tasks. The trait is object-safe via [`async_trait`].
12+
/// across async tasks. The trait is object-safe via [`macro@async_trait`].
1313
///
1414
/// # Example
1515
/// ```rust,no_run

crates/stygian-proxy/src/strategy/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ pub struct ProxyCandidate {
6363
pub trait RotationStrategy: Send + Sync + 'static {
6464
/// Select one candidate from `candidates`.
6565
///
66-
/// Returns [`ProxyError::AllProxiesUnhealthy`] when every candidate has
66+
/// Returns [`crate::error::ProxyError::AllProxiesUnhealthy`] when every candidate has
6767
/// `healthy == false`.
6868
async fn select<'a>(&self, candidates: &'a [ProxyCandidate])
6969
-> ProxyResult<&'a ProxyCandidate>;

0 commit comments

Comments
 (0)