Struct Query 

pub struct Query {
    pub view: Option<View>,
    pub claims: Option<ClaimFilter>,
    pub after: Option<u64>,
    pub session: Option<String>,
    pub runtime: Option<String>,
    pub kind: Option<Kind>,
    pub limit: Option<usize>,
    pub open: Option<bool>,
    pub matching: Option<String>,
}

What a reader asks of the folded state. Every filter narrows; none changes a shape, and an input it does not know is refused rather than ignored.

use majordomus_cli::mesh::page::{ClaimFilter, Query, View};

let q: Query = serde_json::from_str(r#"{"view":"full","claims":"live","limit":5}"#).unwrap();
assert_eq!(q.view(), View::Full);
assert_eq!((q.claims, q.limit), (Some(ClaimFilter::Live), Some(5)));
assert!(serde_json::from_str::<Query>(r#"{"views":"full"}"#).is_err());

Fields

view: Option<View>

summary (the default) or full.

claims: Option<ClaimFilter>

all (the default) or live: whether ended claims are kept.

after: Option<u64>

Only sessions, claims and handovers whose latest Lamport stamp is above this. Reviews and overlaps carry no stamp of their own and are kept or dropped with their sessions.

session: Option<String>

Only what belongs to this session: its key (<stream>/<session>) or its bare id.

runtime: Option<String>

Only what belongs to this runtime: <node>-<runtime>, or a node id for every runtime of that machine.

kind: Option<Kind>

Only this collection; the others are answered empty.

limit: Option<usize>

At most this many of each collection: the newest by Lamport stamp where it has one, kept in the fold’s own order.

open: Option<bool>

Only what is still open: active sessions, live claims, review requests nobody has answered and handovers nobody has taken.

matching: Option<String>

Only what mentions this text, ignoring case: a path, a branch, an issue, a pull request, a word of an intent or a subject.

Implementations

impl Query

pub fn view(&self) -> View

The view asked for, the summary when none was: the one place the default is decided, so every capability that takes a query answers the same view for the same input.

use majordomus_cli::mesh::page::{Query, View};

assert_eq!(Query::default().view(), View::Summary);
let full = Query { view: Some(View::Full), ..Query::default() };
assert_eq!(full.view(), View::Full);

Trait Implementations

impl BenchmarkCases for Query

fn benchmark_cases(_: &CaseContext<'_>) -> Vec<NamedCase<Self>>

The cases, in a stable order. An empty list means “nothing to benchmark in this repository”, which the coverage check reports as missing.

fn benchmark_cases_json(ctx: &CaseContext<'_>) -> Vec<NamedCase<Value>>

The cases as JSON, the shape every runner serialises from.

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Query

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Query

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Query

impl JsonSchema for Query

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Query

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Query