Unified · Split
| @@ -1,7 +1,7 @@ | |||
| 1 | use bstr::{BStr, BString}; | 1 | use bstr::{BStr, BString}; |
| 2 | 2 | ||
| 3 | mod error { | 3 | mod error { |
| 4 | /// The error used in the [credentials helper][action()]. | 4 | /// The error used in the [credentials helper][crate::helper()]. |
| 5 | #[derive(Debug, thiserror::Error)] | 5 | #[derive(Debug, thiserror::Error)] |
| 6 | #[allow(missing_docs)] | 6 | #[allow(missing_docs)] |
| 7 | pub enum Error { | 7 | pub enum Error { |
| @@ -17,7 +17,7 @@ pub use error::Error; · 9 unmodified lines | |||
| 17 | /// The Result type used in [`helper()`][crate::helper()]. | 17 | /// The Result type used in [`helper()`][crate::helper()]. |
| 18 | pub type Result = std::result::Result<Option<Outcome>, Error>; | 18 | pub type Result = std::result::Result<Option<Outcome>, Error>; |
| 19 | 19 | ||
| 20 | /// The action to perform by the credentials [`action()`]. | 20 | /// The action to perform by the credentials [helper][`crate::helper()`]. |
| 21 | #[derive(Clone, Debug)] | 21 | #[derive(Clone, Debug)] |
| 22 | pub enum Action<'a> { | 22 | pub enum Action<'a> { |
| 23 | /// Provide credentials using the given repository URL (as &str) as context. | 23 | /// Provide credentials using the given repository URL (as &str) as context. |
| @@ -58,11 +58,11 @@ impl NextAction { · 34 unmodified lines | |||
| 58 | } | 58 | } |
| 59 | } | 59 | } |
| 60 | 60 | ||
| 61 | /// The outcome of [`action()`]. | 61 | /// The outcome of the credentials [`helper`][crate::helper()]. |
| 62 | pub struct Outcome { | 62 | pub struct Outcome { |
| 63 | /// The obtained identity. | 63 | /// The obtained identity. |
| 64 | pub identity: git_sec::identity::Account, | 64 | pub identity: git_sec::identity::Account, |
| 65 | /// A handle to the action to perform next using another call to [`action()`]. | 65 | /// A handle to the action to perform next in another call to [`helper()`][crate::helper()]. |
| 66 | pub next: NextAction, | 66 | pub next: NextAction, |
| 67 | } | 67 | } |
| 68 | 68 | ||