Skip to main content

TaskFilter

Struct TaskFilter 

Source
pub struct TaskFilter { /* private fields */ }
Expand description

Filters shared by task list and watch operations.

An empty phase filter matches every phase. Multiple with_phase calls accumulate with OR semantics. Slot, label and phase filters are ANDed.

§Example

use solti_model::{Slot, TaskFilter, TaskPhase};

let filter = TaskFilter::new()
    .with_slot(Slot::new("build").unwrap())
    .with_active();

assert_eq!(filter.slot().unwrap().as_str(), "build");
assert!(filter.matches_phase(&TaskPhase::Pending));
assert!(!filter.matches_phase(&TaskPhase::Failed));

Implementations§

Source§

impl TaskFilter

Source

pub fn new() -> Self

Creates an empty filter.

Source

pub fn with_slot(self, slot: Slot) -> Self

Filter by slot name.

Source

pub fn with_phase(self, phase: TaskPhase) -> Self

Adds a phase filter.

Multiple calls accumulate with OR semantics.

Source

pub fn with_phases(self, phases: impl IntoIterator<Item = TaskPhase>) -> Self

Adds phase filters from an iterator.

Values are deduplicated and retain OR semantics.

Source

pub fn with_label_selector(self, selector: LabelSelector) -> ModelResult<Self>

Filter by labels.

Every selector requirement is ANDed. An empty selector matches all tasks.

§Errors

Returns ModelError::Invalid when the selector is invalid.

Source

pub fn with_active(self) -> Self

Filter by all active phases: Pending and Running.

Source

pub fn with_terminal(self) -> Self

Filter by all terminal phases.

Source

pub fn matches(&self, task: &Task) -> bool

Returns whether a task passes every filter.

Source

pub fn matches_phase(&self, phase: &TaskPhase) -> bool

Returns whether a phase passes the phase filter.

An empty filter matches all phases.

Source

pub fn matches_labels(&self, labels: &Labels) -> bool

Returns whether labels pass the selector.

Source

pub fn slot(&self) -> Option<&Slot>

Slot filter (if any).

Source

pub fn phases(&self) -> &[TaskPhase]

Phase filters.

Source

pub fn label_selector(&self) -> &LabelSelector

Label selector.

Trait Implementations§

Source§

impl Clone for TaskFilter

Source§

fn clone(&self) -> TaskFilter

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 TaskFilter

Source§

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

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

impl Default for TaskFilter

Source§

fn default() -> TaskFilter

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

impl<'de> Deserialize<'de> for TaskFilter

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 TaskFilter

Source§

impl PartialEq for TaskFilter

Source§

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

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 TaskFilter

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<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.