Struct Git

Source

pub struct Git<'api, C: Client>where
    AdapterError: From<<C as Client>::Err>,
{ /* private fields */ }

Implementations§

Source §

impl<'api, C: Client> Git<'api, C>
where AdapterError: From<<C as Client>::Err>,

Source

pub async fn create_blob_async( &self, owner: &str, repo: &str, body: PostGitCreateBlob, ) -> Result<ShortBlob, AdapterError>

§Create a blob

GitHub API docs for create_blob

Source

pub fn create_blob( &self, owner: &str, repo: &str, body: PostGitCreateBlob, ) -> Result<ShortBlob, AdapterError>

§Create a blob

GitHub API docs for create_blob

Source

pub async fn create_commit_async( &self, owner: &str, repo: &str, body: PostGitCreateCommit, ) -> Result<GitCommit, AdapterError>

§Create a commit

Creates a new Git commit object.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in the table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for create_commit

Source

pub fn create_commit( &self, owner: &str, repo: &str, body: PostGitCreateCommit, ) -> Result<GitCommit, AdapterError>

§Create a commit

Creates a new Git commit object.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in the table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for create_commit

Source

pub async fn create_ref_async( &self, owner: &str, repo: &str, body: PostGitCreateRef, ) -> Result<GitRef, AdapterError>

§Create a reference

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

GitHub API docs for create_ref

Source

pub fn create_ref( &self, owner: &str, repo: &str, body: PostGitCreateRef, ) -> Result<GitRef, AdapterError>

§Create a reference

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

GitHub API docs for create_ref

Source

pub async fn create_tag_async( &self, owner: &str, repo: &str, body: PostGitCreateTag, ) -> Result<GitTag, AdapterError>

§Create a tag object

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for create_tag

Source

pub fn create_tag( &self, owner: &str, repo: &str, body: PostGitCreateTag, ) -> Result<GitTag, AdapterError>

§Create a tag object

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for create_tag

Source

pub async fn create_tree_async( &self, owner: &str, repo: &str, body: PostGitCreateTree, ) -> Result<GitTree, AdapterError>

§Create a tree

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see “Create a commit” and “Update a reference.”

Returns an error if you try to delete a file that does not exist.

GitHub API docs for create_tree

Source

pub fn create_tree( &self, owner: &str, repo: &str, body: PostGitCreateTree, ) -> Result<GitTree, AdapterError>

§Create a tree

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see “Create a commit” and “Update a reference.”

Returns an error if you try to delete a file that does not exist.

GitHub API docs for create_tree

Source

pub async fn delete_ref_async( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<(), AdapterError>

§Delete a reference

Deletes the provided reference.

GitHub API docs for delete_ref

Source

pub fn delete_ref( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<(), AdapterError>

§Delete a reference

Deletes the provided reference.

GitHub API docs for delete_ref

Source

pub async fn get_blob_async( &self, owner: &str, repo: &str, file_sha: &str, ) -> Result<Blob, AdapterError>

§Get a blob

The content in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see “Media types.”

application/vnd.github.raw+json: Returns the raw blob data.
application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.

Note This endpoint supports blobs up to 100 megabytes in size.

GitHub API docs for get_blob

Source

pub fn get_blob( &self, owner: &str, repo: &str, file_sha: &str, ) -> Result<Blob, AdapterError>

§Get a blob

The content in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see “Media types.”

application/vnd.github.raw+json: Returns the raw blob data.
application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.

Note This endpoint supports blobs up to 100 megabytes in size.

GitHub API docs for get_blob

Source

pub async fn get_commit_async( &self, owner: &str, repo: &str, commit_sha: &str, ) -> Result<GitCommit, AdapterError>

§Get a commit object

Gets a Git commit object.

To get the contents of a commit, see “Get a commit.”

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in the table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for get_commit

Source

pub fn get_commit( &self, owner: &str, repo: &str, commit_sha: &str, ) -> Result<GitCommit, AdapterError>

§Get a commit object

Gets a Git commit object.

To get the contents of a commit, see “Get a commit.”

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in the table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for get_commit

Source

pub async fn get_ref_async( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<GitRef, AdapterError>

§Get a reference

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t match an existing ref, a 404 is returned.

[!NOTE] You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.

GitHub API docs for get_ref

Source

pub fn get_ref( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<GitRef, AdapterError>

§Get a reference

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t match an existing ref, a 404 is returned.

[!NOTE] You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.

GitHub API docs for get_ref

Source

pub async fn get_tag_async( &self, owner: &str, repo: &str, tag_sha: &str, ) -> Result<GitTag, AdapterError>

§Get a tag

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for get_tag

Source

pub fn get_tag( &self, owner: &str, repo: &str, tag_sha: &str, ) -> Result<GitTag, AdapterError>

§Get a tag

Signature verification object

The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:

Name	Type	Description
`verified`	`boolean`	Indicates whether GitHub considers the signature in this commit to be verified.
`reason`	`string`	The reason for verified value. Possible values and their meanings are enumerated in table below.
`signature`	`string`	The signature that was extracted from the commit.
`payload`	`string`	The value that was signed.
`verified_at`	`string`	The date the signature was verified by GitHub.

These are the possible values for reason in the verification object:

Value	Description
`expired_key`	The key that made the signature is expired.
`not_signing_key`	The “signing” flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error`	There was an error communicating with the signature verification service.
`gpgverify_unavailable`	The signature verification service is currently unavailable.
`unsigned`	The object does not include a signature.
`unknown_signature_type`	A non-PGP signature was found in the commit.
`no_user`	No user was associated with the `committer` email address in the commit.
`unverified_email`	The `committer` email address in the commit was associated with a user, but the email address is not verified on their account.
`bad_email`	The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key`	The key that made the signature has not been registered with any user’s account.
`malformed_signature`	There was an error parsing the signature.
`invalid`	The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid`	None of the above errors applied, so the signature is considered to be verified.

GitHub API docs for get_tag

Source

pub async fn get_tree_async( &self, owner: &str, repo: &str, tree_sha: &str, query_params: Option<impl Into<GitGetTreeParams<'api>>>, ) -> Result<GitTree, AdapterError>

§Get a tree

Returns a single tree using the SHA1 value or ref name for that tree.

If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

[!NOTE] The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.

GitHub API docs for get_tree

Source

pub fn get_tree( &self, owner: &str, repo: &str, tree_sha: &str, query_params: Option<impl Into<GitGetTreeParams<'api>>>, ) -> Result<GitTree, AdapterError>

§Get a tree

Returns a single tree using the SHA1 value or ref name for that tree.

If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

[!NOTE] The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.

GitHub API docs for get_tree

Source

pub async fn list_matching_refs_async( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<Vec<GitRef>, AdapterError>

§List matching references

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t exist in the repository, but existing refs start with :ref, they will be returned as an array.

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

[!NOTE] You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.

If you request matching references for a branch named feature but the branch feature doesn’t exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

GitHub API docs for list_matching_refs

Source

pub fn list_matching_refs( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<Vec<GitRef>, AdapterError>

§List matching references

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t exist in the repository, but existing refs start with :ref, they will be returned as an array.

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

[!NOTE] You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.

If you request matching references for a branch named feature but the branch feature doesn’t exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

GitHub API docs for list_matching_refs

Source

pub async fn update_ref_async( &self, owner: &str, repo: &str, git_ref: &str, body: PatchGitUpdateRef, ) -> Result<GitRef, AdapterError>

§Update a reference

Updates the provided reference to point to a new SHA. For more information, see “Git References” in the Git documentation.

GitHub API docs for update_ref

Source

pub fn update_ref( &self, owner: &str, repo: &str, git_ref: &str, body: PatchGitUpdateRef, ) -> Result<GitRef, AdapterError>

§Update a reference

Updates the provided reference to point to a new SHA. For more information, see “Git References” in the Git documentation.

GitHub API docs for update_ref

Auto Trait Implementations§

§

impl<'api, C> Freeze for Git<'api, C>
where AdapterError: Sized,

§

impl<'api, C> RefUnwindSafe for Git<'api, C>
where AdapterError: Sized, C: RefUnwindSafe,

§

impl<'api, C> UnwindSafe for Git<'api, C>
where AdapterError: Sized, C: RefUnwindSafe,

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, U> Into 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, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Struct GitCopy item path

Implementations§

impl<'api, C: Client> Git<'api, C>where AdapterError: From<<C as Client>::Err>,

pub async fn create_blob_async( &self, owner: &str, repo: &str, body: PostGitCreateBlob, ) -> Result<ShortBlob, AdapterError>

§Create a blob

pub fn create_blob( &self, owner: &str, repo: &str, body: PostGitCreateBlob, ) -> Result<ShortBlob, AdapterError>

§Create a blob

pub async fn create_commit_async( &self, owner: &str, repo: &str, body: PostGitCreateCommit, ) -> Result<GitCommit, AdapterError>

§Create a commit

pub fn create_commit( &self, owner: &str, repo: &str, body: PostGitCreateCommit, ) -> Result<GitCommit, AdapterError>

§Create a commit

pub async fn create_ref_async( &self, owner: &str, repo: &str, body: PostGitCreateRef, ) -> Result<GitRef, AdapterError>

§Create a reference

pub fn create_ref( &self, owner: &str, repo: &str, body: PostGitCreateRef, ) -> Result<GitRef, AdapterError>

§Create a reference

pub async fn create_tag_async( &self, owner: &str, repo: &str, body: PostGitCreateTag, ) -> Result<GitTag, AdapterError>

§Create a tag object

pub fn create_tag( &self, owner: &str, repo: &str, body: PostGitCreateTag, ) -> Result<GitTag, AdapterError>

§Create a tag object

pub async fn create_tree_async( &self, owner: &str, repo: &str, body: PostGitCreateTree, ) -> Result<GitTree, AdapterError>

§Create a tree

pub fn create_tree( &self, owner: &str, repo: &str, body: PostGitCreateTree, ) -> Result<GitTree, AdapterError>

§Create a tree

pub async fn delete_ref_async( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<(), AdapterError>

§Delete a reference

pub fn delete_ref( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<(), AdapterError>

§Delete a reference

pub async fn get_blob_async( &self, owner: &str, repo: &str, file_sha: &str, ) -> Result<Blob, AdapterError>

§Get a blob

pub fn get_blob( &self, owner: &str, repo: &str, file_sha: &str, ) -> Result<Blob, AdapterError>

§Get a blob

pub async fn get_commit_async( &self, owner: &str, repo: &str, commit_sha: &str, ) -> Result<GitCommit, AdapterError>

§Get a commit object

pub fn get_commit( &self, owner: &str, repo: &str, commit_sha: &str, ) -> Result<GitCommit, AdapterError>

§Get a commit object

pub async fn get_ref_async( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<GitRef, AdapterError>

§Get a reference

pub fn get_ref( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<GitRef, AdapterError>

§Get a reference

pub async fn get_tag_async( &self, owner: &str, repo: &str, tag_sha: &str, ) -> Result<GitTag, AdapterError>

§Get a tag

pub fn get_tag( &self, owner: &str, repo: &str, tag_sha: &str, ) -> Result<GitTag, AdapterError>

§Get a tag

pub async fn get_tree_async( &self, owner: &str, repo: &str, tree_sha: &str, query_params: Option<impl Into<GitGetTreeParams<'api>>>, ) -> Result<GitTree, AdapterError>

§Get a tree

pub fn get_tree( &self, owner: &str, repo: &str, tree_sha: &str, query_params: Option<impl Into<GitGetTreeParams<'api>>>, ) -> Result<GitTree, AdapterError>

§Get a tree

pub async fn list_matching_refs_async( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<Vec<GitRef>, AdapterError>

§List matching references

pub fn list_matching_refs( &self, owner: &str, repo: &str, git_ref: &str, ) -> Result<Vec<GitRef>, AdapterError>

§List matching references

pub async fn update_ref_async( &self, owner: &str, repo: &str, git_ref: &str, body: PatchGitUpdateRef, ) -> Result<GitRef, AdapterError>

§Update a reference

pub fn update_ref( &self, owner: &str, repo: &str, git_ref: &str, body: PatchGitUpdateRef, ) -> Result<GitRef, AdapterError>

§Update a reference

Auto Trait Implementations§

impl<'api, C> Freeze for Git<'api, C>where AdapterError: Sized,

impl<'api, C> RefUnwindSafe for Git<'api, C>where AdapterError: Sized, C: RefUnwindSafe,

impl<'api, C> Send for Git<'api, C>where AdapterError: Sized, C: Sync,

impl<'api, C> Sync for Git<'api, C>where AdapterError: Sized, C: Sync,

impl<'api, C> Unpin for Git<'api, C>where AdapterError: Sized,

impl<'api, C> UnwindSafe for Git<'api, C>where AdapterError: Sized, C: RefUnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

Struct Git

impl<'api, C: Client> Git<'api, C>
where AdapterError: From<<C as Client>::Err>,

impl<'api, C> Freeze for Git<'api, C>
where AdapterError: Sized,

impl<'api, C> RefUnwindSafe for Git<'api, C>
where AdapterError: Sized, C: RefUnwindSafe,

impl<'api, C> Send for Git<'api, C>
where AdapterError: Sized, C: Sync,

impl<'api, C> Sync for Git<'api, C>
where AdapterError: Sized, C: Sync,

impl<'api, C> Unpin for Git<'api, C>
where AdapterError: Sized,

impl<'api, C> UnwindSafe for Git<'api, C>
where AdapterError: Sized, C: RefUnwindSafe,

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

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

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

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

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

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