Enum extrahop::QueryTime

pub enum QueryTime {
    Milliseconds(i64),
    Unitized(String),
}

Represents an absolute or relative time sent to an ExtraHop appliance as part of a query.

Usage

QueryTime instances should generally be constructed using the conversion traits, rather than directly.

let _time: QueryTime = (-30000 as i64).into();
let _other: QueryTime = "-30m".into();

Variants

Milliseconds(i64)

A number of milliseconds. Positive values are assessed since the Unix epoch, while non-positive values (including 0) are assessed relative to the appliance's "now" value.

Unitized(String)

A possibly-unitized amount of time, expressed as a string.

Methods

impl QueryTime

pub fn is_relative(&self) -> bool

Returns true if the query time is relative to the appliance's "now".

Examples

assert!(QueryTime::from("-30m").is_relative());
assert!(QueryTime::from(0).is_relative());

pub fn is_absolute(&self) -> bool

Returns true if the query time is measured from the Unix epoch.

pub fn validate(self) -> Result<Self>

Check that a query time specification will be accepted by the appliance, returning the unmodified query time if so, and otherwise returning an error.

This function internally calls QueryTime::is_valid.

pub fn is_valid(&self) -> bool

Check that a query time specification will be accepted by the appliance.

Caution

This method attempts to reimplement the appliance's own format checking for unitized time strings, so it is possible that future firmware will accept values not accepted by this method.

Validation

• Numeric time values are allowed without further inspection
• Relative unitized time values must adhere to this expression: ^-\d+(?:ms|s|m|h|d|y)?$
• Absolute unitized time values must be composed of only digits

Examples

// Valid
assert!(QueryTime::from(0).is_valid());
assert!(QueryTime::from(-25000).is_valid());
assert!(QueryTime::from("-1m").is_valid());
assert!(QueryTime::from("-50").is_valid());
assert!(QueryTime::from("-10ms").is_valid());
assert!(QueryTime::from("0").is_valid());

// Invalid
assert!(!QueryTime::from("10m").is_valid());
assert!(!QueryTime::from("1-0").is_valid());

Trait Implementations

impl Clone for QueryTime

fn clone(&self) -> QueryTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for QueryTime

fn default() -> Self

Returns the "default value" for a type.

impl From<i64> for QueryTime

fn from(val: i64) -> Self

Performs the conversion.

impl<'a> From<&'a str> for QueryTime

fn from(val: &str) -> Self

Performs the conversion.

impl From<String> for QueryTime

Convert a string to a query time. This may convert the query time to a number if doing so would not change readability in the serialized form.

fn from(val: String) -> Self

Performs the conversion.

impl Debug for QueryTime

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

Formats the value using the given formatter.

impl FromStr for QueryTime

type Err = Error

The associated error which can be returned from parsing.

fn from_str(v: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Serialize for QueryTime

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for QueryTime

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

Deserialize this value from the given Serde deserializer.