Struct UserSignature

#[non_exhaustive]
pub struct UserSignature {
    pub bcs: Option<Bcs>,
    pub scheme: Option<i32>,
    pub signature: Option<Signature>,
}

A signature from a user.

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.

bcs: Option<Bcs>

This signature serialized as as BCS.

When provided as input this will support both the form that is length prefixed as well as not length prefixed.

scheme: Option<i32>

The signature scheme of this signature.

signature: Option<Signature>

Implementations

impl UserSignature

pub const BCS_FIELD: &'static MessageField

pub const SCHEME_FIELD: &'static MessageField

pub const SIMPLE_FIELD: &'static MessageField

pub const MULTISIG_FIELD: &'static MessageField

pub const ZKLOGIN_FIELD: &'static MessageField

pub const PASSKEY_FIELD: &'static MessageField

impl UserSignature

pub fn path_builder() -> UserSignatureFieldPathBuilder

impl UserSignature

pub const fn const_default() -> Self

pub fn bcs(&self) -> &Bcs

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

pub fn bcs_opt_mut(&mut self) -> Option<&mut Bcs>

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

pub fn bcs_mut(&mut self) -> &mut Bcs

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

pub fn bcs_opt(&self) -> Option<&Bcs>

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

pub fn set_bcs<T: Into<Bcs>>(&mut self, field: T)

Sets bcs with the provided value.

pub fn with_bcs<T: Into<Bcs>>(self, field: T) -> Self

Sets bcs with the provided value.

pub fn with_scheme<T: Into<SignatureScheme>>(self, field: T) -> Self

Sets scheme with the provided value.

pub fn simple(&self) -> &SimpleSignature

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

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

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

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

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

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

Returns a mutable reference to simple. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

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

Sets simple with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

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

Sets simple with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn multisig(&self) -> &MultisigAggregatedSignature

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

pub fn multisig_opt(&self) -> Option<&MultisigAggregatedSignature>

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

pub fn multisig_opt_mut(&mut self) -> Option<&mut MultisigAggregatedSignature>

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

pub fn multisig_mut(&mut self) -> &mut MultisigAggregatedSignature

Returns a mutable reference to multisig. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn set_multisig<T: Into<MultisigAggregatedSignature>>(&mut self, field: T)

Sets multisig with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_multisig<T: Into<MultisigAggregatedSignature>>( self, field: T, ) -> Self

Sets multisig with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn zklogin(&self) -> &ZkLoginAuthenticator

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

pub fn zklogin_opt(&self) -> Option<&ZkLoginAuthenticator>

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

pub fn zklogin_opt_mut(&mut self) -> Option<&mut ZkLoginAuthenticator>

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

pub fn zklogin_mut(&mut self) -> &mut ZkLoginAuthenticator

Returns a mutable reference to zklogin. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn set_zklogin<T: Into<ZkLoginAuthenticator>>(&mut self, field: T)

Sets zklogin with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_zklogin<T: Into<ZkLoginAuthenticator>>(self, field: T) -> Self

Sets zklogin with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn passkey(&self) -> &PasskeyAuthenticator

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

pub fn passkey_opt(&self) -> Option<&PasskeyAuthenticator>

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

pub fn passkey_opt_mut(&mut self) -> Option<&mut PasskeyAuthenticator>

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

pub fn passkey_mut(&mut self) -> &mut PasskeyAuthenticator

Returns a mutable reference to passkey. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn set_passkey<T: Into<PasskeyAuthenticator>>(&mut self, field: T)

Sets passkey with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_passkey<T: Into<PasskeyAuthenticator>>(self, field: T) -> Self

Sets passkey with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

impl UserSignature

pub fn scheme(&self) -> SignatureScheme

Returns the enum value of scheme, or the default if the field is unset or set to an invalid enum value.

pub fn set_scheme(&mut self, value: SignatureScheme)

Sets scheme to the provided enum value.

Trait Implementations

impl Clone for UserSignature

fn clone(&self) -> UserSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserSignature

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

Formats the value using the given formatter.

impl Default for UserSignature

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserSignature

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<UserSignature> for UserSignature

fn from(value: UserSignature) -> Self

Converts to this type from the input type.

impl Merge<&UserSignature> for UserSignature

fn merge(&mut self, source: &UserSignature, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<UserSignature> for UserSignature

fn merge(&mut self, source: UserSignature, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Message for UserSignature

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 UserSignature

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

impl PartialEq for UserSignature

fn eq(&self, other: &UserSignature) -> 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 UserSignature

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&UserSignature> for UserSignature

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for UserSignature