Enum ProcessSelector 

pub enum ProcessSelector {
    All,
    Id(u32),
    Name(String),
    Regex(Regex),
    Fold(String),
    Instance {
        name: String,
        slot: u32,
    },
}

A parsed process selector (spec §9: name, id, all, /regex/, fold:)

Variants

All

Every sheep in the flock

Id(u32)

By numeric id

Name(String)

By exact name

Regex(Regex)

By regex over names (slash-delimited on the CLI)

Fold(String)

Every sheep in a fold

Instance

One instance of one app, written name:slot on the CLI

Fields

name: String

The app name, which cannot itself contain a colon

slot: u32

The instance slot, counting from 0

Implementations

impl ProcessSelector

pub fn parse(input: &str) -> Result<Self, SelectorError>

Parses CLI selector syntax

Errors

• SelectorError::Empty — empty input.
• SelectorError::EmptyFold — fold: with no name.
• SelectorError::BadRegex — /re/ body rejected by the regex crate (carries its message).
• SelectorError::BadGlob — a pattern carrying *, ?, [ or { was rejected by globset (carries its message).

pub const fn is_exact(&self) -> bool

Whether this selector names ONE entry the caller already knew of, by its name or its id, rather than sweeping whatever matches.

The distinction a dog turns on: a dog is a process an operator installed, not a member of the flock all means, so a wildcard must pass it by while shep restart metrics still reaches it. Self::Regex and Self::Fold are wildcards here even when they happen to match one entry — what matters is that the operator did not name it.

pub fn matches( &self, name: &str, id: u32, fold: Option<&str>, instance: Option<u32>, ) -> bool

Tests one sheep against this selector

Trait Implementations

impl Clone for ProcessSelector

fn clone(&self) -> ProcessSelector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessSelector

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

Formats the value using the given formatter.

impl From<&ProcessSelector> for SelectorSpec

fn from(sel: &ProcessSelector) -> Self

Converts to this type from the input type.

impl TryFrom<SelectorSpec> for ProcessSelector

fn try_from(spec: SelectorSpec) -> Result<Self, Self::Error>

Compiles a wire selector into a matchable one

Errors

• SelectorError::BadRegex — the peer-supplied pattern fails to compile or exceeds the 1 MiB compiled-size bound.

type Error = SelectorError

The type returned in the event of a conversion error.