Skip to main content

JobQuery

Struct JobQuery 

Source
pub struct JobQuery {
Show 15 fields pub repository: Option<String>, pub state: Option<JobState>, pub conclusion: Option<String>, pub workflow: Option<String>, pub name: Option<String>, pub since: Option<u64>, pub until: Option<u64>, pub before: Option<u64>, pub limit: Option<u32>, pub q: Option<String>, pub branch: Option<String>, pub record: Option<RecordFilter>, pub sort: Option<JobSort>, pub order: Option<SortOrder>, pub cursor: Option<String>,
}
Expand description

GET /v1/jobs query parameters. Jobs come newest first (by ID, which grows with time), or by sort (ADR 0135). JobQuery::check says which queries the daemon refuses.

Fields§

§repository: Option<String>

Only this owner/name.

§state: Option<JobState>

Only jobs in this state.

§conclusion: Option<String>

Only jobs with this conclusion, such as failure.

§workflow: Option<String>

Only jobs of the workflow with this name, such as CI.

§name: Option<String>

Only jobs with this name in their workflow, such as build.

§since: Option<u64>

Only jobs queued at or after this time.

§until: Option<u64>

Only jobs queued before this time.

§before: Option<u64>

Only jobs with a smaller ID: the next of the previous page. Only in the default order, newest first.

§limit: Option<u32>

At most this many jobs; default 50, at most 500. A page also ends once it holds JOBS_PAGE_BYTES of text.

§q: Option<String>

Only jobs whose name, workflow or branch holds this text, as written: 1 to JOB_SEARCH_MAX bytes, ASCII letters in either case. The history keeps no commit, so a commit is not searched.

§branch: Option<String>

Only jobs of runs for this branch.

§record: Option<RecordFilter>

Only jobs whose record this says became of.

§sort: Option<JobSort>

Sort by this; a job whose figure is unknown comes last either way, ties by ID. queued, newest first, is the default order, which pages with before; any other order is one page, the first limit jobs.

§order: Option<SortOrder>

Which way; default largest or latest first.

§cursor: Option<String>

Refused: a sorted list is one page, which a search or the filters narrow. Read only to say so.

Implementations§

Source§

impl JobQuery

Source

pub fn check(&self) -> Result<(), String>

Checks a query before it is read: a search of 1 to JOB_SEARCH_MAX bytes without control characters, before only in the default order, and no cursor. Returns the reason to refuse it, worded for its user.

Source

pub fn pages(&self) -> bool

Whether it lists in the default order, newest first by ID, the one order that pages, with before and next.

Source

pub fn page_size(&self) -> u32

How many jobs a page holds: limit, within 1 and JOBS_PAGE_MAX.

Source

pub fn admits(&self, job: &JobSummary) -> bool

Whether job passes its filters: not its paging.

Source

pub fn page(&self, jobs: &[JobSummary]) -> Result<JobList, String>

The page this query reads of jobs, a whole history held in memory, as the store reads it from the database: for the demo’s fake daemon and tests. Refuses what check refuses.

Source

pub fn answer( &self, jobs: Vec<JobSummary>, more: bool, total: u64, shortened: Vec<u64>, ) -> JobList

A page of jobs, in order, of the total the filters admit, shortened those whose text was cut: with the next page’s next when more follow in the default order, and total in any other.

Trait Implementations§

Source§

impl Clone for JobQuery

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JobQuery

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for JobQuery

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for JobQuery

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for JobQuery

Source§

impl PartialEq for JobQuery

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for JobQuery

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for JobQuery

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more