Struct MultisigAggregatedSignature

#[non_exhaustive]
pub struct MultisigAggregatedSignature {
    pub signatures: Vec<MultisigMemberSignature>,
    pub bitmap: Option<u32>,
    pub legacy_bitmap: Vec<u32>,
    pub committee: Option<MultisigCommittee>,
}

Aggregated signature from members of a multisig committee.

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.

signatures: Vec<MultisigMemberSignature>

The plain signatures encoded with signature scheme.

The signatures must be in the same order as they are listed in the committee.

bitmap: Option<u32>

Bitmap indicating which committee members contributed to the signature.

legacy_bitmap: Vec<u32>

If present, means this signature’s on-chain format uses the old legacy multisig format.

committee: Option<MultisigCommittee>

The committee to use to validate this signature.

Implementations

impl MultisigAggregatedSignature

pub const SIGNATURES_FIELD: &'static MessageField

pub const BITMAP_FIELD: &'static MessageField

pub const LEGACY_BITMAP_FIELD: &'static MessageField

pub const COMMITTEE_FIELD: &'static MessageField

impl MultisigAggregatedSignature

pub fn path_builder() -> MultisigAggregatedSignatureFieldPathBuilder

impl MultisigAggregatedSignature

pub const fn const_default() -> Self

pub fn signatures(&self) -> &[MultisigMemberSignature]

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

pub fn signatures_mut(&mut self) -> &mut Vec<MultisigMemberSignature>

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

pub fn set_signatures(&mut self, field: Vec<MultisigMemberSignature>)

Sets signatures with the provided value.

pub fn with_signatures(self, field: Vec<MultisigMemberSignature>) -> Self

Sets signatures with the provided value.

pub fn bitmap_opt_mut(&mut self) -> Option<&mut u32>

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

pub fn bitmap_mut(&mut self) -> &mut u32

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

pub fn bitmap_opt(&self) -> Option<u32>

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

pub fn set_bitmap<T: Into<u32>>(&mut self, field: T)

Sets bitmap with the provided value.

pub fn with_bitmap<T: Into<u32>>(self, field: T) -> Self

Sets bitmap with the provided value.

pub fn legacy_bitmap(&self) -> &[u32]

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

pub fn legacy_bitmap_mut(&mut self) -> &mut Vec<u32>

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

pub fn set_legacy_bitmap(&mut self, field: Vec<u32>)

Sets legacy_bitmap with the provided value.

pub fn with_legacy_bitmap(self, field: Vec<u32>) -> Self

Sets legacy_bitmap with the provided value.

pub fn committee(&self) -> &MultisigCommittee

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

pub fn committee_opt_mut(&mut self) -> Option<&mut MultisigCommittee>

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

pub fn committee_mut(&mut self) -> &mut MultisigCommittee

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

pub fn committee_opt(&self) -> Option<&MultisigCommittee>

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

pub fn set_committee<T: Into<MultisigCommittee>>(&mut self, field: T)

Sets committee with the provided value.

pub fn with_committee<T: Into<MultisigCommittee>>(self, field: T) -> Self

Sets committee with the provided value.

impl MultisigAggregatedSignature

pub fn bitmap(&self) -> u32

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

Trait Implementations

impl Clone for MultisigAggregatedSignature

fn clone(&self) -> MultisigAggregatedSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultisigAggregatedSignature

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

Formats the value using the given formatter.

impl Default for MultisigAggregatedSignature

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MultisigAggregatedSignature

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&MultisigAggregatedSignature> for MultisigAggregatedSignature

fn from(value: &MultisigAggregatedSignature) -> Self

Converts to this type from the input type.

impl Message for MultisigAggregatedSignature

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 MultisigAggregatedSignature

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

impl PartialEq for MultisigAggregatedSignature

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&MultisigAggregatedSignature> for MultisigAggregatedSignature

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for MultisigAggregatedSignature