Struct Subscribe

pub struct Subscribe<'a> {
    pub common_fields: CommonFields<'a>,
    pub accounts: Option<Vec<Cow<'a, str>>>,
    pub accounts_proposed: Option<Vec<Cow<'a, str>>>,
    pub books: Option<Vec<SubscribeBook<'a>>>,
    pub streams: Option<Vec<StreamParameter>>,
    pub url: Option<Cow<'a, str>>,
    pub url_password: Option<Cow<'a, str>>,
    pub url_username: Option<Cow<'a, str>>,
}

The subscribe method requests periodic notifications from the server when certain events happen.

Note: WebSocket API only.

See Subscribe: <https://xrpl.org/subscribe.html>

Fields

common_fields: CommonFields<'a>

The common fields shared by all requests.

accounts: Option<Vec<Cow<'a, str>>>

Array with the unique addresses of accounts to monitor for validated transactions. The addresses must be in the XRP Ledger’s base58 format. The server sends a notification for any transaction that affects at least one of these accounts.

accounts_proposed: Option<Vec<Cow<'a, str>>>

Like accounts, but include transactions that are not yet finalized.

books: Option<Vec<SubscribeBook<'a>>>

Array of objects defining order books to monitor for updates, as detailed below.

streams: Option<Vec<StreamParameter>>

Array of string names of generic streams to subscribe to.

url: Option<Cow<'a, str>>

(Optional for Websocket; Required otherwise) URL where the server sends a JSON-RPC callbacks for each event. Admin-only.

url_password: Option<Cow<'a, str>>

Password to provide for basic authentication at the callback URL.

url_username: Option<Cow<'a, str>>

Username to provide for basic authentication at the callback URL.

Implementations

impl<'a> Subscribe<'a>

pub fn new( id: Option<Cow<'a, str>>, accounts: Option<Vec<Cow<'a, str>>>, accounts_proposed: Option<Vec<Cow<'a, str>>>, books: Option<Vec<SubscribeBook<'a>>>, streams: Option<Vec<StreamParameter>>, url: Option<Cow<'a, str>>, url_password: Option<Cow<'a, str>>, url_username: Option<Cow<'a, str>>, ) -> Self

Trait Implementations

impl<'a> Clone for Subscribe<'a>

fn clone(&self) -> Subscribe<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Subscribe<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Subscribe<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<Subscribe<'a>> for XRPLRequest<'a>

fn from(request: Subscribe<'a>) -> Self

Converts to this type from the input type.

impl<'a> Model for Subscribe<'a>

fn get_errors(&self) -> XRPLModelResult<()>

Collects a models errors and returns the first error that occurs.

fn validate(&self) -> XRPLModelResult<()>

Simply forwards the error from get_errors if there was one.

fn is_valid(&self) -> bool

Checks if the model is valid.

impl<'a> PartialEq for Subscribe<'a>

fn eq(&self, other: &Subscribe<'a>) -> 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<'a> Request<'a> for Subscribe<'a>

fn get_common_fields(&self) -> &CommonFields<'a>

fn get_common_fields_mut(&mut self) -> &mut CommonFields<'a>

impl<'a> Serialize for Subscribe<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Subscribe<'a>

impl<'a> StructuralPartialEq for Subscribe<'a>