actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-06-15 15:16:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

docstrings for things that I was curious about

Browse source
This commit is contained in:
David Laban 2024-09-10 17:54:37 +01:00
parent a88335d05b
commit ae13308dec
2 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
crates/binstalk-fetchers/src/common.rs
View file

@ -24,6 +24,9 @@ use crate::FetchError;
static WARN_RATE_LIMIT_ONCE: Once = Once::new(); static WARN_RATE_LIMIT_ONCE: Once = Once::new();
static WARN_UNAUTHORIZED_ONCE: Once = Once::new(); static WARN_UNAUTHORIZED_ONCE: Once = Once::new();
/// Return Ok(Some(api_artifact_url)) if exists, or Ok(None) if it doesn't.
///
/// Caches info on all artifacts matching (repo, tag).
pub(super) async fn get_gh_release_artifact_url( pub(super) async fn get_gh_release_artifact_url(
gh_api_client: GhApiClient, gh_api_client: GhApiClient,
artifact: GhReleaseArtifact, artifact: GhReleaseArtifact,
@ -54,6 +57,10 @@ pub(super) async fn get_gh_release_artifact_url(
} }
} }
/// Check if the URL exists by querying the GitHub API.
///
/// Caches info on all artifacts matching (repo, tag).
///
/// This function returns a future where its size should be at most size of /// This function returns a future where its size should be at most size of
/// 2-4 pointers. /// 2-4 pointers.
pub(super) async fn does_url_exist( pub(super) async fn does_url_exist(

2
crates/binstalk-git-repo-api/src/gh_api_client.rs
View file

@ -247,6 +247,8 @@ pub struct GhReleaseArtifactUrl(Url);
impl GhApiClient { impl GhApiClient {
/// Return `Ok(Some(api_artifact_url))` if exists. /// Return `Ok(Some(api_artifact_url))` if exists.
///
/// Caches info on all artifacts matching (repo, tag).
/// ///
/// The returned future is guaranteed to be pointer size. /// The returned future is guaranteed to be pointer size.
#[instrument(skip(self), ret(level = Level::DEBUG))] #[instrument(skip(self), ret(level = Level::DEBUG))]