Struct ChainedDocumentQuery 

pub struct ChainedDocumentQuery {
    pub inner: DocumentQuery,
    pub join_property: String,
    pub outer_document_type_name: String,
}

A chained document query: the inner DocumentQuery plus the join edge. The outer half has no clauses by design — it is derived.

The inner query MUST carry an explicit non-zero limit (it bounds the derived outer query; there is no server-default sentinel on this surface) and must resolve, server-side, to an indexOnly index carrying join_property.

Fields

inner: DocumentQuery

The inner query (the subselect).

join_property: String

The inner property whose proven values become the outer $ids. Must carry a same-contract refersTo: permanentDocument declaration targeting outer_document_type_name.

outer_document_type_name: String

The outer (joined) document type — the refersTo target.

Implementations

impl ChainedDocumentQuery

pub fn new( inner: DocumentQuery, join_property: impl Into<String>, outer_document_type_name: impl Into<String>, ) -> ChainedDocumentQuery

A chained query joining inner’s join_property values onto documents of outer_document_type_name.

Trait Implementations

impl Clone for ChainedDocumentQuery

fn clone(&self) -> ChainedDocumentQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChainedDocumentQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChainedDocumentQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromProof<ChainedDocumentQuery> for ChainedDocuments

type Request = ChainedDocumentQuery

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, O>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<ChainedDocuments>, ResponseMetadata, Proof), Error>

where I: Into<<ChainedDocuments as FromProof<ChainedDocumentQuery>>::Request>, O: Into<<ChainedDocuments as FromProof<ChainedDocumentQuery>>::Response>, ChainedDocuments: '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 ChainedDocumentQuery

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

Serialize the message to bytes for mocking purposes.

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

Deserialize the message serialized with [mock_serialize()].

impl PartialEq for ChainedDocumentQuery

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

fn query( &self, settings: &QuerySettings<'_>, ) -> Result<ChainedDocumentQuery, Error>

Convert the query into a wire-shape [TransportRequest].

impl Query<GetDocumentsRequest> for ChainedDocumentQuery

Encode a ChainedDocumentQuery onto the wire.

The Fetch trampoline for drive_proof_verifier::ChainedDocuments splits Query = ChainedDocumentQuery (rich, what FromProof binds to) from Request = GetChainedDocumentsRequest (wire); this impl is the rich→wire step.

fn query( &self, settings: &QuerySettings<'_>, ) -> Result<GetDocumentsRequest, Error>

Convert the query into a wire-shape [TransportRequest].

impl Serialize for ChainedDocumentQuery

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 StructuralPartialEq for ChainedDocumentQuery

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( request: &'a ChainedDocumentQuery, ) -> Result<DriveDocumentQuery<'a>, <DriveDocumentQuery<'a> as TryFrom<&'a ChainedDocumentQuery>>::Error>

Performs the conversion.

impl TryFromPlatformVersioned<ChainedDocumentQuery> for GetDocumentsRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from_platform_versioned( value: ChainedDocumentQuery, platform_version: &PlatformVersion, ) -> Result<GetDocumentsRequest, <GetDocumentsRequest as TryFromPlatformVersioned<ChainedDocumentQuery>>::Error>

Performs the conversion.