Skip to content

Make Binding public #940

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
merged 1 commit into from
Aug 15, 2025
Merged

Make Binding public #940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ pub use crate::tracing::{trace_set, TraceLevel};
pub use crate::transaction::Transaction;
pub use crate::tree::{Tree, TreeEntry, TreeIter, TreeWalkMode, TreeWalkResult};
pub use crate::treebuilder::TreeBuilder;
pub use crate::util::IntoCString;
pub use crate::util::{Binding, IntoCString};
pub use crate::version::Version;
pub use crate::worktree::{Worktree, WorktreeAddOptions, WorktreeLockStatus, WorktreePruneOptions};

Expand Down
16 changes: 15 additions & 1 deletion src/util.rs
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

How does exporting this trait sound? It would allow for an escape hatch to be able to interact with libgit2-sys.

I think the change is small and fine to merge. However, I'd like to understand what can't be done or hard to do before this patch. Would you mind showing some examples of before and after?

Copy link

Choose a reason for hiding this comment

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

The reason I initially pinged @edrevo to update the PR and ping rustbot to get it merged was because of WorktreeAddOptions missing an API to set checkout_options.

I ended up solving it a different way and I was in fact holding it wrong, but giving the user the capability to access the underlying C-API seems generally useful.

Copy link
Member

Choose a reason for hiding this comment

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

I see. Thanks!

Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,27 @@ impl<T> IsNull for *mut T {
}
}

#[doc(hidden)]
/// Provides access to the raw libgit2 pointer to be able to interact with libgit2-sys.
///
/// If you are going to depend on this trait on your code, do consider contributing to the git2
Copy link
Member

Choose a reason for hiding this comment

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

I love this being called out. Thank you.

/// project to add the missing capabilities to git2.
pub trait Binding: Sized {
/// The raw type that allows you to interact with libgit2-sys.
type Raw;

/// Build a git2 struct from its [Binding::Raw] value.
unsafe fn from_raw(raw: Self::Raw) -> Self;

/// Access the [Binding::Raw] value for a struct.
///
/// The returned value is only safe to use while its associated git2 struct is in scope.
/// Once the associated git2 struct is destroyed, the raw value can point to an invalid memory address.
fn raw(&self) -> Self::Raw;

/// A null-handling version of [Binding::from_raw].
///
/// If the input parameter is null, then the funtion returns None. Otherwise, it
/// calls [Binding::from_raw].
unsafe fn from_raw_opt<T>(raw: T) -> Option<Self>
where
T: Copy + IsNull,
Expand Down
Loading