Struct Selector

pub struct Selector<'a> { /* private fields */ }

A time series selector that is gradually built from a metric name and/or a set of label matchers.

Implementations

impl<'a> Selector<'a>

pub fn new() -> Self

Create a new instance of Selector.

pub fn metric(self, metric: &'a str) -> Self

where Self: Sized,

Select a metric name for this Selector.

use prometheus_http_query::Selector;

let select = Selector::new().metric("http_requests_total");

// This is equal to:
let other_select = Selector::new().eq("__name__", "http_requests_total");

assert_eq!(select, other_select);

pub fn eq(self, label: &'a str, value: &'a str) -> Self

where Self: Sized,

Append a label matcher to the set of matchers of Selector that selects labels that match the provided string.
PromQL equivalent: http_requests_total{job="apiserver"}

use prometheus_http_query::Selector;

let select = Selector::new()
    .metric("http_requests_total")
    .eq("job", "apiserver")
    .to_string();

let expected = r#"{__name__="http_requests_total",job="apiserver"}"#.to_string();

assert_eq!(select, expected);

pub fn ne(self, label: &'a str, value: &'a str) -> Self

where Self: Sized,

Append a label matcher to the set of matchers of Selector that selects labels that do not match the provided string.
PromQL equivalent: http_requests_total{job!="apiserver"}

use prometheus_http_query::Selector;

let select = Selector::new()
    .metric("http_requests_total")
    .ne("job", "apiserver")
    .to_string();

let expected = r#"{__name__="http_requests_total",job!="apiserver"}"#.to_string();

assert_eq!(select, expected);

pub fn regex_eq(self, label: &'a str, value: &'a str) -> Self

where Self: Sized,

Append a label matcher to the set of matchers of Selector that selects labels that regex-match the provided string. PromQL equivalent: http_requests_total{job=~"apiserver"}

use prometheus_http_query::Selector;

let select = Selector::new()
    .metric("http_requests_total")
    .regex_eq("job", "apiserver")
    .to_string();

let expected = r#"{__name__="http_requests_total",job=~"apiserver"}"#.to_string();

assert_eq!(select, expected);

pub fn regex_ne(self, label: &'a str, value: &'a str) -> Self

where Self: Sized,

Append a label matcher to the set of matchers of Selector that selects labels that do not regex-match the provided string.
PromQL equivalent: http_requests_total{job!~"apiserver"}

use prometheus_http_query::Selector;

let select = Selector::new()
    .metric("http_requests_total")
    .regex_ne("job", "apiserver")
    .to_string();

let expected = r#"{__name__="http_requests_total",job!~"apiserver"}"#.to_string();

assert_eq!(select, expected);

Trait Implementations

impl<'a> Clone for Selector<'a>

fn clone(&self) -> Selector<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Selector<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Selector<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for Selector<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Selector<'a>

fn eq(&self, other: &Selector<'a>) -> 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<'a> StructuralPartialEq for Selector<'a>