Struct fractal::components::dialogs::auth::AuthDialog

#[repr(transparent)]
pub struct AuthDialog {
    inner: TypedObjectRef<AuthDialog, <AuthDialog as ObjectSubclass>::ParentType>,
    phantom: PhantomData<()>,
}

Dialog to guide the user through the [User-Interactive Authentication API] (UIAA).

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<AuthDialog, <AuthDialog as ObjectSubclass>::ParentType>

phantom: PhantomData<()>

Implementations

impl AuthDialog

pub fn session(&self) -> <WeakRef<Session> as Property>::Value

pub fn parent(&self) -> <WeakRef<Widget> as Property>::Value

pub fn connect_session_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_parent_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn notify_session(&self)

pub fn notify_parent(&self)

impl AuthDialog

pub fn new(session: &Session) -> Self

pub async fn authenticate<Response: Send + 'static, F1: Future<Output = Result<Response, Error>> + Send + 'static, FN: Fn(Client, Option<AuthData>) -> F1 + Send + 'static + Sync + Clone>( &self, parent: &impl IsA<Widget>, callback: FN, ) -> Result<Response, AuthError>

Authenticates the user to the server via an authentication flow.

The type of flow and the required stages are negotiated at time of authentication. Returns the last server response on success.

async fn perform_next_stage( &self, uiaa_session: &Option<String>, stages: &[&AuthType], ) -> Result<AuthData, AuthError>

Performs the most preferred one of the given stages.

Stages that Fractal actually implements are preferred.

async fn try_perform_stage( &self, uiaa_session: &Option<String>, stage: &AuthType, ) -> Option<Result<AuthData, AuthError>>

Tries to perform the given stage.

Returns None if the stage is not implemented by Fractal.

async fn perform_password_stage( &self, uiaa_session: Option<String>, ) -> Result<AuthData, AuthError>

Performs the password stage.

fn perform_dummy_stage( &self, uiaa_session: Option<String>, ) -> Result<AuthData, AuthError>

Performs the dummy stage.

async fn perform_fallback( &self, uiaa_session: Option<String>, stage: &AuthType, ) -> Result<AuthData, AuthError>

Performs a web-based fallback for the given stage.

async fn show_and_wait_for_response(&self) -> Result<(), AuthError>

Lets the user complete the current stage.

fn show_auth_error(&self, auth_error: &Option<StandardErrorBody>)

fn setup_fallback_page( &self, homeserver: &str, auth_type: &str, uiaa_session: &str, )

Trait Implementations

impl Clone for AuthDialog

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for AuthDialog

type ParamSpec = ParamSpecObject

type SetValue = AuthDialog

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, AuthDialog>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AuthDialog

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for AuthDialog

type Subclass = AuthDialog

impl Ord for AuthDialog

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for AuthDialog

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for AuthDialog

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for AuthDialog

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AuthDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AuthDialog

impl IsA<Accessible> for AuthDialog

impl IsA<AlertDialog> for AuthDialog

impl IsA<Dialog> for AuthDialog

impl IsA<Widget> for AuthDialog