Struct EnterReq 

pub struct EnterReq {
    pub identifying_attr: Option<Signed<Attr>>,
    pub mode: EnterMode,
    pub add_attrs: Vec<Signed<Attr>>,
    pub register_only_with_unique_attrs: bool,
}

Request to log in to an existing account, or register a new one.

Also used to add attributes to the new or existing user account.

May fail with ErrorCode::BadRequest when:

• identifying_attr is not identifying
• The same attribute appears twice among add_attrs and identifying_attr.
• A non-addable attribute is in add_attrs (such as a pubhubs card attribute not obtained via the auths::CardEP endpoint.
• Neither an identifying nor a auth token (via the Authorization header) is provided.
• When the auth token is used, but the mode is not login.

Fields

identifying_attr: Option<Signed<Attr>>

Attribute identifying the user.

If omitted, an AuthToken must be passed via the Authorization header instead.

mode: EnterMode

The mode determines whether we want to create an account if none exists, and whether we expect an account to exist.

add_attrs: Vec<Signed<Attr>>

Add these attributes to your account, required, for example, when registering a new account, or when no bannable attribute is registered for this account.

register_only_with_unique_attrs: bool

When the registration of a new user account is needed for this request, check that none of the provided attributes already bans another user. If one of the supplied attributes does ban another user, EnterResp::AttributeAlreadyTaken is returned.

Checking for this condition is useful when an end-user already has an account, supplied one attribute that bans it, but not an identifying attribute tied to their original account. If this check is not performed, a second account is created, which is not what the user might want. With this check, the frontend can prompt the user to confirm that they really do want to create a (potential) second account.

Trait Implementations

impl Clone for EnterReq

fn clone(&self) -> EnterReq

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnterReq

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

Formats the value using the given formatter.

impl Default for EnterReq

fn default() -> EnterReq

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EnterReq

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EnterReq

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.