diff --git a/crates/binstalk-fetchers/src/common.rs b/crates/binstalk-fetchers/src/common.rs index 10272f10..310efead 100644 --- a/crates/binstalk-fetchers/src/common.rs +++ b/crates/binstalk-fetchers/src/common.rs @@ -24,6 +24,9 @@ use crate::FetchError; static WARN_RATE_LIMIT_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( gh_api_client: GhApiClient, 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 /// 2-4 pointers. pub(super) async fn does_url_exist( diff --git a/crates/binstalk-git-repo-api/src/gh_api_client.rs b/crates/binstalk-git-repo-api/src/gh_api_client.rs index 8773fa11..df5008cf 100644 --- a/crates/binstalk-git-repo-api/src/gh_api_client.rs +++ b/crates/binstalk-git-repo-api/src/gh_api_client.rs @@ -247,6 +247,8 @@ pub struct GhReleaseArtifactUrl(Url); impl GhApiClient { /// 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. #[instrument(skip(self), ret(level = Level::DEBUG))]