Skip to content

Make all Url fields public and replace unreachable! with proper error handling #2141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Byron merged 7 commits into from
Aug 28, 2025
Merged

Make all Url fields public and replace unreachable! with proper error handling #2141

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
33df529
Initial plan
Copilot Aug 28, 2025
f82eb73
Make all Url fields public and add mutability warning to docs
Copilot Aug 28, 2025
b2afc1c
Clarify mutability warning to specify parsing vs reconstruction
Copilot Aug 28, 2025
fbe454e
Replace all unreachable! with proper error handling in gix-url
Copilot Aug 28, 2025
c29bd0a
Address PR feedback: use Error::other() and revert unnecessary changes
Copilot Aug 28, 2025
519e769
fix formatting, clippy
Byron Aug 28, 2025
52c8edb
fixup cargo deny - ignore async-std
Byron Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions gix-url/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ pub enum ArgumentSafety<'a> {
///
/// Additionally there is support for [deserialization](Url::from_bytes()) and [serialization](Url::to_bstring()).
///
/// # Mutability Warning
///
/// Due to the mutability of this type, it's possible that the URL serializes to something invalid
/// when fields are modified directly. The URL should be accepted as a parameter directly rather
/// than being reconstructed, to maintain validity guarantees.
Copy link
Member

@Byron Byron Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Make clear that the URL to accept in parameters should always be parsed to this type, but never be an instance of this type.

Copy link
Contributor Author

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the mutability warning to clarify that URLs should always be parsed to this type from string or byte parameters, but never be accepted as an instance of this type and then reconstructed. Commit: f1e98e5

///
/// # Security Warning
///
/// URLs may contain passwords and using standard [formatting](std::fmt::Display) will redact
Expand All @@ -93,13 +99,13 @@ pub struct Url {
/// The URL scheme.
pub scheme: Scheme,
/// The user to impersonate on the remote.
user: Option<String>,
pub user: Option<String>,
/// The password associated with a user.
password: Option<String>,
pub password: Option<String>,
/// The host to which to connect. Localhost is implied if `None`.
host: Option<String>,
pub host: Option<String>,
/// When serializing, use the alternative forms as it was parsed as such.
serialize_alternative_form: bool,
pub serialize_alternative_form: bool,
/// The port to use when connecting to a host. If `None`, standard ports depending on `scheme` will be used.
pub port: Option<u16>,
/// The path portion of the URL, usually the location of the git repository.
Expand Down
Loading