chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client-api: Fix serialized form of IdentityProviderBrand and improve its docs

Browse Source
This commit is contained in:
Jonas Platte 2022-02-02 16:36:47 +01:00
parent eeba51d4d6
commit 5668ebde5a
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
crates/ruma-client-api/src/r0/session/get_login_types.rs
View File

@ -182,35 +182,41 @@ impl IdentityProvider {
} }
/// An SSO login identity provider brand identifier. /// An SSO login identity provider brand identifier.
///
/// The predefined ones can be found in the matrix-doc repo in a [separate document][matrix-doc].
/// To use a custom brand string, simply use `IdentityProviderBrand::from("custom-brand")` or
/// `"custom-brand".into()` (if the type is known from the surrounding context).
///
/// [matrix-doc]: https://github.com/matrix-org/matrix-doc/blob/v1.1/informal/idp-brands.md
#[derive(Clone, Debug, PartialEq, Eq, StringEnum)] #[derive(Clone, Debug, PartialEq, Eq, StringEnum)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)] #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub enum IdentityProviderBrand { pub enum IdentityProviderBrand {
/// The [Apple] brand. /// The [Apple] brand.
/// ///
/// [Apple]: https://developer.apple.com/design/human-interface-guidelines/sign-in-with-apple/overview/buttons/ /// [Apple]: https://developer.apple.com/design/human-interface-guidelines/sign-in-with-apple/overview/buttons/
#[ruma_enum(rename = "org.matrix.apple")] #[ruma_enum(rename = "apple")]
Apple, Apple,
/// The [Facebook](https://developers.facebook.com/docs/facebook-login/web/login-button/) brand. /// The [Facebook](https://developers.facebook.com/docs/facebook-login/web/login-button/) brand.
#[ruma_enum(rename = "org.matrix.facebook")] #[ruma_enum(rename = "facebook")]
Facebook, Facebook,
/// The [GitHub](https://github.com/logos) brand. /// The [GitHub](https://github.com/logos) brand.
#[ruma_enum(rename = "org.matrix.github")] #[ruma_enum(rename = "github")]
GitHub, GitHub,
/// The [GitLab](https://about.gitlab.com/press/press-kit/) brand. /// The [GitLab](https://about.gitlab.com/press/press-kit/) brand.
#[ruma_enum(rename = "org.matrix.gitlab")] #[ruma_enum(rename = "gitlab")]
GitLab, GitLab,
/// The [Google](https://developers.google.com/identity/branding-guidelines) brand. /// The [Google](https://developers.google.com/identity/branding-guidelines) brand.
#[ruma_enum(rename = "org.matrix.google")] #[ruma_enum(rename = "google")]
Google, Google,
/// The [Twitter] brand. /// The [Twitter] brand.
/// ///
/// [Twitter]: https://developer.twitter.com/en/docs/authentication/guides/log-in-with-twitter#tab1 /// [Twitter]: https://developer.twitter.com/en/docs/authentication/guides/log-in-with-twitter#tab1
#[ruma_enum(rename = "org.matrix.twitter")] #[ruma_enum(rename = "twitter")]
Twitter, Twitter,
/// A custom brand. /// A custom brand.