Trait dash_sdk::platform::Query

pub trait Query<T: TransportRequest + Mockable>: Send + Debug + Clone {
    // Required method
    fn query(self, prove: bool) -> Result<T, Error>;
}

Trait implemented by objects that can be used as queries.

Query trait is used to specify criteria for fetching data from Platform. It can be used to specify individual objects as well as search criteria for fetching multiple objects from Platform.

Some examples of queries include:

1. Identifier - fetches an object by its identifier; implemented for Identity, DataContract and Document.
2. DocumentQuery - fetches Document based on search conditions; see query syntax documentation for more details.

Example

To fetch individual Identity object by its Identifier, you just need to create it and use Fetch or FetchMany trait:

use dash_sdk::{Sdk, platform::{Query, Identifier, Fetch, Identity}};

let sdk = Sdk::new_mock();
let query = Identifier::new(SOME_IDENTIFIER);
let identity = Identity::fetch(&sdk, query);

As Identifier implements Query, the query variable in the code above can be used as a parameter for Fetch::fetch() and FetchMany::fetch_many() methods.

Required Methods

fn query(self, prove: bool) -> Result<T, Error>

Converts the current instance into an instance of the TransportRequest type.

This method takes ownership of the instance upon which it’s called (hence self), and attempts to perform the conversion.

Arguments

• prove - Whether to include proofs in the response. Only true is supported at the moment.

Returns

On success, this method yields an instance of the TransportRequest type (T). On failure, it yields an Error.

Error Handling

This method propagates any errors encountered during the conversion process. These are returned as Error instances.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Query<GetContestedResourceIdentityVotesRequest> for ContestedResourceVotesGivenByIdentityQuery

fn query( self, prove: bool, ) -> Result<GetContestedResourceIdentityVotesRequest, Error>

impl Query<GetContestedResourceIdentityVotesRequest> for ProTxHash

fn query( self, prove: bool, ) -> Result<GetContestedResourceIdentityVotesRequest, Error>

impl Query<GetContestedResourceVoteStateRequest> for ContestedDocumentVotePollDriveQuery

fn query( self, prove: bool, ) -> Result<GetContestedResourceVoteStateRequest, Error>

impl Query<GetContestedResourceVotersForIdentityRequest> for ContestedDocumentVotePollVotesDriveQuery

fn query( self, prove: bool, ) -> Result<GetContestedResourceVotersForIdentityRequest, Error>

impl Query<GetContestedResourcesRequest> for VotePollsByDocumentTypeQuery

fn query(self, prove: bool) -> Result<GetContestedResourcesRequest, Error>

impl Query<GetDataContractsRequest> for Vec<Identifier>

fn query(self, prove: bool) -> Result<GetDataContractsRequest, Error>

impl Query<GetEpochsInfoRequest> for EpochIndex

fn query(self, prove: bool) -> Result<GetEpochsInfoRequest, Error>

impl Query<GetIdentityContractNonceRequest> for (Identifier, Identifier)

fn query(self, prove: bool) -> Result<GetIdentityContractNonceRequest, Error>

impl Query<GetPathElementsRequest> for KeysInPath

fn query(self, prove: bool) -> Result<GetPathElementsRequest, Error>

impl Query<GetProtocolVersionUpgradeStateRequest> for ()

fn query( self, prove: bool, ) -> Result<GetProtocolVersionUpgradeStateRequest, Error>

impl Query<GetProtocolVersionUpgradeVoteStatusRequest> for Option<ProTxHash>

Convenience method that allows direct use of a ProTxHash

fn query( self, prove: bool, ) -> Result<GetProtocolVersionUpgradeVoteStatusRequest, Error>

impl Query<GetProtocolVersionUpgradeVoteStatusRequest> for ProTxHash

Convenience method that allows direct use of a ProTxHash

fn query( self, prove: bool, ) -> Result<GetProtocolVersionUpgradeVoteStatusRequest, Error>

impl Query<GetTotalCreditsInPlatformRequest> for NoParamQuery

fn query(self, prove: bool) -> Result<GetTotalCreditsInPlatformRequest, Error>

impl Query<GetVotePollsByEndDateRequest> for VotePollsByEndDateDriveQuery

fn query(self, prove: bool) -> Result<GetVotePollsByEndDateRequest, Error>

Implementors

impl Query<IdentityRequest> for Identifier

impl Query<IdentityRequest> for PublicKeyHash

impl Query<GetContestedResourceIdentityVotesRequest> for LimitQuery<VoteQuery>

impl Query<GetContestedResourceVoteStateRequest> for LimitQuery<ContestedDocumentVotePollDriveQuery>

impl Query<GetContestedResourceVotersForIdentityRequest> for LimitQuery<GetContestedResourceVotersForIdentityRequest>

impl Query<GetContestedResourcesRequest> for LimitQuery<GetContestedResourcesRequest>

impl Query<GetDataContractHistoryRequest> for LimitQuery<(Identifier, u64)>

impl Query<GetDataContractRequest> for Identifier

impl Query<GetEpochsInfoRequest> for EpochQuery

impl Query<GetIdentityBalanceAndRevisionRequest> for Identifier

impl Query<GetIdentityBalanceRequest> for Identifier

impl Query<GetIdentityKeysRequest> for Identifier

impl Query<GetIdentityNonceRequest> for Identifier

impl Query<GetPrefundedSpecializedBalanceRequest> for Identifier

impl Query<GetProtocolVersionUpgradeVoteStatusRequest> for LimitQuery<Option<ProTxHash>>

impl Query<GetProtocolVersionUpgradeVoteStatusRequest> for LimitQuery<ProTxHash>

Convenience method that allows direct use of a ProTxHash

impl<'a> Query<DocumentQuery> for DriveDocumentQuery<'a>

impl<E: Into<EpochQuery> + Clone + Debug + Send> Query<GetEpochsInfoRequest> for LimitQuery<E>

impl<T> Query<T> for T

where T: TransportRequest + Sized + Send + Sync + Clone + Debug, T::Response: Send + Sync + Debug,