Struct dash_sdk::platform::DocumentQuery

pub struct DocumentQuery {
    pub data_contract: Arc<DataContract>,
    pub document_type_name: String,
    pub where_clauses: Vec<WhereClause>,
    pub order_by_clauses: Vec<OrderClause>,
    pub limit: u32,
    pub start: Option<Start>,
}

Request that is used to query documents from the Dash Platform.

This is an abstraction layer built on top of GetDocumentsRequest to address issues with missing details required to correctly verify proofs returned by the Dash Platform.

Conversions are implemented between this type, GetDocumentsRequest and DriveDocumentQuery using TryFrom trait.

Fields

data_contract: Arc<DataContract>

Data contract ID

document_type_name: String

Document type for the data contract

where_clauses: Vec<WhereClause>

where clauses for the query

order_by_clauses: Vec<OrderClause>

order_by clauses for the query

limit: u32

queryset limit

start: Option<Start>

first object to start with

Implementations

impl DocumentQuery

pub fn new<C: Into<Arc<DataContract>>>( contract: C, document_type_name: &str, ) -> Result<Self, Error>

Create new DocumentQuery for provided contract and document type name.

pub fn new_with_drive_query(d: &DriveDocumentQuery<'_>) -> Self

Create new document query based on a DriveDocumentQuery.

pub async fn new_with_data_contract_id( api: &Sdk, data_contract_id: Identifier, document_type_name: &str, ) -> Result<Self, Error>

Create new document query for provided document type name and data contract ID.

Note that this method will fetch data contract first.

pub fn with_document_id(self, document_id: &Identifier) -> Self

Point to a specific document ID.

pub fn with_where(self, clause: WhereClause) -> Self

Add new where clause to the query.

Existing where clauses will be preserved.

pub fn with_order_by(self, clause: OrderClause) -> Self

Add order by clause to the query.

Existing order by clauses will be preserved.

Trait Implementations

impl Clone for DocumentQuery

fn clone(&self) -> DocumentQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a DriveDocumentQuery<'a>> for DocumentQuery

fn from(value: &'a DriveDocumentQuery<'a>) -> Self

Converts to this type from the input type.

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

fn from(value: DriveDocumentQuery<'a>) -> Self

Converts to this type from the input type.

impl FromProof<DocumentQuery> for Documents

type Request = DocumentQuery

Request type for which this trait is implemented.

type Response = GetDocumentsResponse

Response type for which this trait is implemented.

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

fn maybe_from_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Option<Self>, Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

fn from_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Self, Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof.

fn from_proof_with_metadata<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata), Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

fn from_proof_with_metadata_and_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata, Proof), Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

impl FromProof<DocumentQuery> for Document

type Request = DocumentQuery

Request type for which this trait is implemented.

type Response = GetDocumentsResponse

Response type for which this trait is implemented.

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

fn maybe_from_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Option<Self>, Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

fn from_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Self, Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof.

fn from_proof_with_metadata<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata), Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

fn from_proof_with_metadata_and_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata, Proof), Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

impl Mockable for DocumentQuery

fn mock_serialize(&self) -> Option<Vec<u8>>

Serialize the message to bytes for mocking purposes.

fn mock_deserialize(data: &[u8]) -> Option<Self>

Deserialize the message serialized with [mock_serialize()].

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

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

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

impl Serialize for DocumentQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TransportRequest for DocumentQuery

type Client = <GetDocumentsRequest as TransportRequest>::Client

A client specific to this type of transport.

type Response = <GetDocumentsRequest as TransportRequest>::Response

Transport layer response.

const SETTINGS_OVERRIDES: RequestSettings = <GetDocumentsRequest as TransportRequest>::SETTINGS_OVERRIDES

Settings that will override DapiClient’s ones each time the request is executed.

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

gRPC request name

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

gRPC method name

fn execute_transport<'c>( self, client: &'c mut Self::Client, settings: &AppliedRequestSettings, ) -> BoxFuture<'c, Result<Self::Response, <Self::Client as TransportClient>::Error>>

Perform transport request asynchronously.

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

gRPC response name

impl<'a> TryFrom<&'a DocumentQuery> for DriveDocumentQuery<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(request: &'a DocumentQuery) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DocumentQuery> for GetDocumentsRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(dapi_request: DocumentQuery) -> Result<Self, Self::Error>

Performs the conversion.