Skip to content

Commit 143a60f

Browse files
committed
chore: document differences between similar Credentials methods
1 parent d2c6a91 commit 143a60f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/app-lib/src/state/minecraft_auth.rs

+4
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,8 @@ impl Credentials {
411411
)
412412
}
413413

414+
/// Like [`get_active`](Self::get_active), but enforces credentials to be
415+
/// successfully refreshed unless the network is unreachable or times out.
414416
#[tracing::instrument]
415417
pub async fn get_default_credential(
416418
exec: impl sqlx::Executor<'_, Database = sqlx::Sqlite> + Copy,
@@ -443,6 +445,8 @@ impl Credentials {
443445
}
444446
}
445447

448+
/// Fetches the currently selected credentials from the database, attempting
449+
/// to refresh them if they are expired.
446450
pub async fn get_active(
447451
exec: impl sqlx::Executor<'_, Database = sqlx::Sqlite> + Copy,
448452
) -> crate::Result<Option<Self>> {

0 commit comments

Comments
 (0)