Struct CatalogueQuery 

pub struct CatalogueQuery {
    pub canonical_route: Option<CanonicalActionRoute>,
    pub provider: Option<String>,
    pub view_resource: Option<ViewResourceQuery>,
    pub parent_resource: Option<String>,
    pub needle: String,
    pub target: Option<ActionAddress>,
    pub revision: Option<String>,
    pub cursor: Vec<u8>,
    pub max_results: u32,
    pub limits: Option<CatalogueLimits>,
}

One bounded request for catalogue rows. Every field narrows; the empty query lists the first page of everything offered.

Fields

canonical_route: Option<CanonicalActionRoute>

Provider-only lookup of one exact route’s custodian. Cannot accompany a provider, cursor, target, view lookup, or row filter.

provider: Option<String>

Only rows from this provider (a token a previous page issued).

view_resource: Option<ViewResourceQuery>

Read-only view discovery, separate from the document action catalogue.

parent_resource: Option<String>

Only the direct children of this resource; None is the top level.

needle: String

Only rows whose labels, ids or parameters contain this text (case-insensitive).

target: Option<ActionAddress>

Only this exact action, re-resolved against the provider now: the check to make immediately before invoking a row from an older page.

revision: Option<String>

The revision cursor (or target) was obtained at. A host refuses a cursor from another revision as stale rather than skipping rows.

cursor: Vec<u8>

Opaque continuation from the previous page; empty starts over.

max_results: u32

Upper bound on rows, clamped to MAX_CATALOGUE_PAGE. With no provider named, zero asks only for CataloguePage::providers.

limits: Option<CatalogueLimits>

Optional upper bounds on the work a provider spends answering.

Implementations

impl CatalogueQuery

pub fn resolve( target: &RemoteActionTarget, revision: impl Into<String>, ) -> CatalogueQuery

A query that re-resolves exactly target at revision.

pub fn page_size(&self) -> usize

The page size a host honours for this query.

Trait Implementations

impl Clone for CatalogueQuery

fn clone(&self) -> CatalogueQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogueQuery

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

Formats the value using the given formatter.

impl Default for CatalogueQuery

fn default() -> CatalogueQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogueQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogueQuery

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

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 Eq for CatalogueQuery

impl StructuralPartialEq for CatalogueQuery