Siklos/libgit2dart
1
0
Fork 0
mirror of https://github.com/SkinnyMind/libgit2dart.git synced 2025-05-05 04:39:07 -04:00
Code Issues Projects Releases Wiki Activity

refactor!: use Finalizer to automatically free allocated memory for objects (#48)

Browse source 
BREAKING CHANGE: signature change for remote and repository callbacks during repository clone operation.
This commit is contained in:
Aleksey Kulikov 2022-04-28 11:04:48 +03:00 • committed by GitHub
parent 94c40f9a94
commit a3213a88a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
103 changed files with 2278 additions and 2595 deletions
Download patch file Download diff file Expand all files Collapse all files

39
lib/src/remote.dart
View file

@ -8,18 +8,15 @@ class Remote {
///
/// The [name] will be checked for validity.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Remote.lookup({required Repository repo, required String name}) {
_remotePointer = bindings.lookup(repoPointer: repo.pointer, name: name);
_finalizer.attach(this, _remotePointer, detach: this);
}
/// Adds remote with provided [name] and [url] to the [repo]sitory's
/// configuration with the default [fetch] refspec if none provided.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
Remote.create({
required Repository repo,
@ -41,12 +38,11 @@ class Remote {
fetch: fetch,
);
}
_finalizer.attach(this, _remotePointer, detach: this);
}
late final Pointer<git_remote> _remotePointer;
/// Pointer to memory address for allocated remote object.
Pointer<git_remote> get pointer => _remotePointer;
late final Pointer<git_remote> _remotePointer;
/// Deletes an existing persisted remote with provided [name].
///
@ -298,7 +294,10 @@ class Remote {
}
/// Releases memory allocated for remote object.
void free() => bindings.free(_remotePointer);
void free() {
bindings.free(_remotePointer);
_finalizer.detach(this);
}
@override
String toString() {
@ -307,6 +306,12 @@ class Remote {
}
}
// coverage:ignore-start
final _finalizer = Finalizer<Pointer<git_remote>>(
(pointer) => bindings.free(pointer),
);
// coverage:ignore-end
/// Provides callers information about the progress of indexing a packfile,
/// either directly or part of a fetch or clone that downloads a packfile.
class TransferProgress {
@ -346,3 +351,21 @@ class TransferProgress {
'indexedDeltas: $indexedDeltas, receivedBytes: $receivedBytes}';
}
}
class RemoteCallback {
/// Values used to override the remote creation and customization process
/// during a repository clone operation.
///
/// Remote will have provided [name] and [url] with the default [fetch]
/// refspec if none provided.
const RemoteCallback({required this.name, required this.url, this.fetch});
/// Remote's name.
final String name;
/// Remote's url.
final String url;
/// Remote's fetch refspec.
final String? fetch;
}