Struct ZkLoginAuthenticator 

#[non_exhaustive]
pub struct ZkLoginAuthenticator {
    pub inputs: Option<ZkLoginInputs>,
    pub max_epoch: Option<u64>,
    pub signature: Option<SimpleSignature>,
    pub public_identifier: Option<ZkLoginPublicIdentifier>,
    pub jwk_id: Option<JwkId>,
}

A zklogin authenticator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

inputs: Option<ZkLoginInputs>

Zklogin proof and inputs required to perform proof verification.

max_epoch: Option<u64>

Maximum epoch for which the proof is valid.

signature: Option<SimpleSignature>

User signature with the public key attested to by the provided proof.

public_identifier: Option<ZkLoginPublicIdentifier>

The public identifier (similar to a public key) for this zklogin authenticator

jwk_id: Option<JwkId>

The id of the JWK used to authorize this zklogin authenticator

Implementations

impl ZkLoginAuthenticator

pub const INPUTS_FIELD: &'static MessageField

pub const MAX_EPOCH_FIELD: &'static MessageField

pub const SIGNATURE_FIELD: &'static MessageField

pub const PUBLIC_IDENTIFIER_FIELD: &'static MessageField

pub const JWK_ID_FIELD: &'static MessageField

impl ZkLoginAuthenticator

pub fn path_builder() -> ZkLoginAuthenticatorFieldPathBuilder

impl ZkLoginAuthenticator

pub const fn const_default() -> Self

pub fn inputs(&self) -> &ZkLoginInputs

Returns the value of inputs, or the default value if inputs is unset.

pub fn inputs_opt_mut(&mut self) -> Option<&mut ZkLoginInputs>

If inputs is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn inputs_mut(&mut self) -> &mut ZkLoginInputs

Returns a mutable reference to inputs. If the field is unset, it is first initialized with the default value.

pub fn inputs_opt(&self) -> Option<&ZkLoginInputs>

If inputs is set, returns Some with the value; otherwise returns None.

pub fn set_inputs<T: Into<ZkLoginInputs>>(&mut self, field: T)

Sets inputs with the provided value.

pub fn with_inputs<T: Into<ZkLoginInputs>>(self, field: T) -> Self

Sets inputs with the provided value.

pub fn max_epoch_opt_mut(&mut self) -> Option<&mut u64>

If max_epoch is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn max_epoch_mut(&mut self) -> &mut u64

Returns a mutable reference to max_epoch. If the field is unset, it is first initialized with the default value.

pub fn max_epoch_opt(&self) -> Option<u64>

If max_epoch is set, returns Some with the value; otherwise returns None.

pub fn set_max_epoch(&mut self, field: u64)

Sets max_epoch with the provided value.

pub fn with_max_epoch(self, field: u64) -> Self

Sets max_epoch with the provided value.

pub fn signature(&self) -> &SimpleSignature

Returns the value of signature, or the default value if signature is unset.

pub fn signature_opt_mut(&mut self) -> Option<&mut SimpleSignature>

If signature is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn signature_mut(&mut self) -> &mut SimpleSignature

Returns a mutable reference to signature. If the field is unset, it is first initialized with the default value.

pub fn signature_opt(&self) -> Option<&SimpleSignature>

If signature is set, returns Some with the value; otherwise returns None.

pub fn set_signature<T: Into<SimpleSignature>>(&mut self, field: T)

Sets signature with the provided value.

pub fn with_signature<T: Into<SimpleSignature>>(self, field: T) -> Self

Sets signature with the provided value.

pub fn public_identifier(&self) -> &ZkLoginPublicIdentifier

Returns the value of public_identifier, or the default value if public_identifier is unset.

pub fn public_identifier_opt_mut( &mut self, ) -> Option<&mut ZkLoginPublicIdentifier>

If public_identifier is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn public_identifier_mut(&mut self) -> &mut ZkLoginPublicIdentifier

Returns a mutable reference to public_identifier. If the field is unset, it is first initialized with the default value.

pub fn public_identifier_opt(&self) -> Option<&ZkLoginPublicIdentifier>

If public_identifier is set, returns Some with the value; otherwise returns None.

pub fn set_public_identifier<T: Into<ZkLoginPublicIdentifier>>( &mut self, field: T, )

Sets public_identifier with the provided value.

pub fn with_public_identifier<T: Into<ZkLoginPublicIdentifier>>( self, field: T, ) -> Self

Sets public_identifier with the provided value.

pub fn jwk_id(&self) -> &JwkId

Returns the value of jwk_id, or the default value if jwk_id is unset.

pub fn jwk_id_opt_mut(&mut self) -> Option<&mut JwkId>

If jwk_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn jwk_id_mut(&mut self) -> &mut JwkId

Returns a mutable reference to jwk_id. If the field is unset, it is first initialized with the default value.

pub fn jwk_id_opt(&self) -> Option<&JwkId>

If jwk_id is set, returns Some with the value; otherwise returns None.

pub fn set_jwk_id<T: Into<JwkId>>(&mut self, field: T)

Sets jwk_id with the provided value.

pub fn with_jwk_id<T: Into<JwkId>>(self, field: T) -> Self

Sets jwk_id with the provided value.

impl ZkLoginAuthenticator

pub fn max_epoch(&self) -> u64

Returns the value of max_epoch, or the default value if max_epoch is unset.

Trait Implementations

impl Clone for ZkLoginAuthenticator

fn clone(&self) -> ZkLoginAuthenticator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZkLoginAuthenticator

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

Formats the value using the given formatter.

impl Default for ZkLoginAuthenticator

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ZkLoginAuthenticator

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ZkLoginAuthenticator> for ZkLoginAuthenticator

fn from(value: ZkLoginAuthenticator) -> Self

Converts to this type from the input type.

impl Hash for ZkLoginAuthenticator

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

Feeds this value into the given Hasher.

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 Message for ZkLoginAuthenticator

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for ZkLoginAuthenticator

const FIELDS: &'static [&'static MessageField]

impl PartialEq for ZkLoginAuthenticator

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

Tests for self and other values to be equal, and is used by ==.

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 Serialize for ZkLoginAuthenticator

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ZkLoginAuthenticator> for ZkLoginAuthenticator

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &ZkLoginAuthenticator) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ZkLoginAuthenticator

impl StructuralPartialEq for ZkLoginAuthenticator