Skip to main content

SanitizedRegistryError

Struct SanitizedRegistryError 

Source
pub struct SanitizedRegistryError(/* private fields */);
Expand description

Wraps a reqwest::Error with its embedded request URL stripped, for storage in DepsError::RegistryError’s source field.

reqwest::Error’s own Display appends " for url (...)" when the underlying error carries a URL — reqwest::Error::without_url() strips this, but relying on every RegistryError-construction site to remember to call it is exactly the discipline gap this type closes (issue #789, see RedactedUrl’s own docs for the same problem on the URL-string side). The only constructor (From<reqwest::Error>) applies .without_url() unconditionally, so a raw URL can never reach DepsError’s Display/Debug through {source} forwarding, even when a future call site forgets.

self.0’s own source chain is never exposed, through either Debug or std::error::Error::source — this is deliberate, not an oversight. .without_url() only clears the outer error’s own url field; reqwest’s source field is independent of it, and that source is not always a URL-free hyper/io error: reqwest 0.13.4’s redirect policy (src/redirect.rs, the https_only check in TowerPolicy::redirect) rejects an http:// redirect target by building crate::error::redirect(crate::error::url_bad_scheme(next_url.clone()), next_url) — the inner url_bad_scheme(...) error is itself a full reqwest::Error with next_url populated via .with_url(...), nested as the outer error’s source. That inner url is a field .without_url() on the outer error never touches, and reqwest::Error’s own derived-style Debug impl recursively prints source’s Debug (including that inner url) — so both a manual .source() walk and {:?} on the raw reqwest::Error can leak it. Since reqwest exposes no source_mut()-style API to reach in and strip that nested URL, this type treats itself as a leaf node instead: its std::error::Error::source impl always returns None, and Debug is hand-written to forward to the (already-safe) Display text rather than to self.0’s own Debug.

Precision note on what is actually verified today: this project’s own client configuration never calls reqwest::ClientBuilder::https_only (grep -rn '\.https_only(' crates/ finds no hits), so the nested-URL shape above cannot currently occur through this crate’s own request paths — the regression test below instead exercises a genuinely populated source chain via a real connection-refused (io-level) failure, which is what this project’s client config can actually produce, and confirms it is discarded. The https_only/redirect mechanism itself is read directly from reqwest 0.13.4’s pinned source (redirect.rs), not reproduced live here (doing so would need a TLS test harness this project does not otherwise have). source() returning None unconditionally — not only when a URL-bearing nested error is possible — is what makes this correct regardless: if a future change enables https_only on a shared client, this type’s contract does not need re-auditing.

§Examples

use deps_core::error::SanitizedRegistryError;

// A builder-only `reqwest::Error` never carries a URL in the first place, so this
// demonstrates the wrapper's `Display`/`Debug` forwarding without needing a real request.
let raw = reqwest::Client::new().get("not a url").build().unwrap_err();
let sanitized: SanitizedRegistryError = raw.into();
assert!(!sanitized.to_string().is_empty());

Trait Implementations§

Source§

impl Debug for SanitizedRegistryError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Hand-written, not derived: forwards to Display (safe — reqwest::Error’s own Display never recurses into its source’s text) instead of self.0’s own Debug, which does recurse into source and would reopen the nested-URL leak this type’s own docs describe.

Source§

impl Display for SanitizedRegistryError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for SanitizedRegistryError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Always None — see this type’s own docs for why the wrapped error’s source chain is never safe to expose, even via this trait’s usual chain-walking contract.

1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<Error> for SanitizedRegistryError

Source§

fn from(error: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more