Struct TimeFilter

pub struct TimeFilter {
    pub start: Option<String>,
    pub end: Option<String>,
    pub span: Option<String>,
}

Represents a time range for log query.

This struct allows various formats to express a time range from the user side for best flexibility:

• Only start is provided: the start string can be any valid “date” or vaguer content. For example: “2024-12-01”, “2024-12”, “2024”, etc. It will be treated as an time range corresponding to the provided date. E.g., “2024-12-01” refers to the entire 24 hours in that day. In this case, the start field cannot be a timestamp (like “2024-12-01T12:00:00Z”).
• Both start and end are provided: the start and end strings can be either a date or a timestamp. The end field is exclusive ([start, end)). When start is a date it implies the start of the day, and when end is a date it implies the end of the day.
• span with start OR end: the span string can be any valid “interval” For example: “1024s”, “1 week”, “1 month”, etc. The span field is applied to the start or end field to calculate the other one correspondingly. If start is provided, end is calculated as start + span and vice versa.
• Only span is provided: the span string can be any valid “interval” as mentioned above. In this case, the current time (on the server side) is considered as the end.
• All fields are provided: in this case, the start and end fields are considered with higher priority, and the span field is ignored.

This struct doesn’t require a timezone to be presented. When the timezone is not provided, it will fill the default timezone with the same rules akin to other queries.

Fields

start: Option<String>

end: Option<String>

span: Option<String>

Implementations

impl TimeFilter

pub fn canonicalize(&mut self) -> Result<()>

Validate and canonicalize the time filter.

This function will try to fill the missing fields and convert all dates to timestamps

fn parse_datetime(s: &str) -> Result<(DateTime<Utc>, Option<DateTime<Utc>>)>

Util function returns a start and optional end DateTime

fn parse_span(s: &str) -> Result<Duration>

Util function handles durations like “1 week”, “1 month”, etc (unimplemented).

Trait Implementations

impl Clone for TimeFilter

fn clone(&self) -> TimeFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeFilter

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

Formats the value using the given formatter.

impl Default for TimeFilter

fn default() -> TimeFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TimeFilter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.