Enum soroban_sdk::xdr::StellarMessage

pub enum StellarMessage {
    ErrorMsg(SError),
    Hello(Hello),
    Auth(Auth),
    DontHave(DontHave),
    GetPeers,
    Peers(VecM<PeerAddress, 100>),
    GetTxSet(Uint256),
    TxSet(TransactionSet),
    GeneralizedTxSet(GeneralizedTransactionSet),
    Transaction(TransactionEnvelope),
    SurveyRequest(SignedSurveyRequestMessage),
    SurveyResponse(SignedSurveyResponseMessage),
    GetScpQuorumset(Uint256),
    ScpQuorumset(ScpQuorumSet),
    ScpMessage(ScpEnvelope),
    GetScpState(u32),
    SendMore(SendMore),
    SendMoreExtended(SendMoreExtended),
    FloodAdvert(FloodAdvert),
    FloodDemand(FloodDemand),
}

StellarMessage is an XDR Union defines as:

union StellarMessage switch (MessageType type)
{
case ERROR_MSG:
    Error error;
case HELLO:
    Hello hello;
case AUTH:
    Auth auth;
case DONT_HAVE:
    DontHave dontHave;
case GET_PEERS:
    void;
case PEERS:
    PeerAddress peers<100>;

case GET_TX_SET:
    uint256 txSetHash;
case TX_SET:
    TransactionSet txSet;
case GENERALIZED_TX_SET:
    GeneralizedTransactionSet generalizedTxSet;

case TRANSACTION:
    TransactionEnvelope transaction;

case SURVEY_REQUEST:
    SignedSurveyRequestMessage signedSurveyRequestMessage;

case SURVEY_RESPONSE:
    SignedSurveyResponseMessage signedSurveyResponseMessage;

// SCP
case GET_SCP_QUORUMSET:
    uint256 qSetHash;
case SCP_QUORUMSET:
    SCPQuorumSet qSet;
case SCP_MESSAGE:
    SCPEnvelope envelope;
case GET_SCP_STATE:
    uint32 getSCPLedgerSeq; // ledger seq requested ; if 0, requests the latest
case SEND_MORE:
    SendMore sendMoreMessage;
case SEND_MORE_EXTENDED:
    SendMoreExtended sendMoreExtendedMessage;
// Pull mode
case FLOOD_ADVERT:
     FloodAdvert floodAdvert;
case FLOOD_DEMAND:
     FloodDemand floodDemand;
};

Variants

ErrorMsg(SError)

Hello(Hello)

Auth(Auth)

DontHave(DontHave)

GetPeers

Peers(VecM<PeerAddress, 100>)

GetTxSet(Uint256)

TxSet(TransactionSet)

GeneralizedTxSet(GeneralizedTransactionSet)

Transaction(TransactionEnvelope)

SurveyRequest(SignedSurveyRequestMessage)

SurveyResponse(SignedSurveyResponseMessage)

GetScpQuorumset(Uint256)

ScpQuorumset(ScpQuorumSet)

ScpMessage(ScpEnvelope)

GetScpState(u32)

SendMore(SendMore)

SendMoreExtended(SendMoreExtended)

FloodAdvert(FloodAdvert)

FloodDemand(FloodDemand)

Implementations

impl StellarMessage

pub const VARIANTS: [MessageType; 20] = _

pub const VARIANTS_STR: [&'static str; 20] = _

pub const fn name(&self) -> &'static str

pub const fn discriminant(&self) -> MessageType

pub const fn variants() -> [MessageType; 20]

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for StellarMessage

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StellarMessage, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest( u: Unstructured<'arbitrary> ) -> Result<StellarMessage, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for StellarMessage

fn clone(&self) -> StellarMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StellarMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StellarMessage

fn deserialize<__D>( __deserializer: __D ) -> Result<StellarMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Discriminant<MessageType> for StellarMessage

fn discriminant(&self) -> MessageType

impl Hash for StellarMessage

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

where __H: Hasher,

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 Name for StellarMessage

fn name(&self) -> &'static str

impl Ord for StellarMessage

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

This method returns an Ordering between self and other.

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 PartialEq for StellarMessage

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for StellarMessage

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl ReadXdr for StellarMessage

fn read_xdr<R>(r: &mut Limited<R>) -> Result<StellarMessage, Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_base64<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Construct the type from the XDR bytes base64 encoded.

fn read_xdr_to_end<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Read the XDR and construct the type, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_base64_to_end<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Construct the type from the XDR bytes base64 encoded.

fn read_xdr_into<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_into_to_end<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR into the existing value, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_iter<R>(r: &mut Limited<R>) -> ReadXdrIter<&mut R, Self>

where R: Read,

Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.

fn read_xdr_base64_iter<R>( r: &mut Limited<R> ) -> ReadXdrIter<DecoderReader<'_, R>, Self>

where R: Read,

Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.

fn from_xdr(bytes: impl AsRef<[u8]>, limits: Limits) -> Result<Self, Error>

Construct the type from the XDR bytes.

fn from_xdr_base64(b64: impl AsRef<[u8]>, limits: Limits) -> Result<Self, Error>

Construct the type from the XDR bytes base64 encoded.

impl Serialize for StellarMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Variants<MessageType> for StellarMessage

fn variants() -> Iter<'static, MessageType>

impl WriteXdr for StellarMessage

fn write_xdr<W>(&self, w: &mut Limited<W>) -> Result<(), Error>

where W: Write,

fn to_xdr(&self, limits: Limits) -> Result<Vec<u8>, Error>

fn to_xdr_base64(&self, limits: Limits) -> Result<String, Error>

impl Eq for StellarMessage

impl StructuralEq for StellarMessage

impl StructuralPartialEq for StellarMessage

impl Union<MessageType> for StellarMessage