Enum watchman_client::pdu::ClockSpec

pub enum ClockSpec {
    StringClock(String),
    UnixTimestamp(i64),
}

The fundamental clock specifier string. The contents of the string should be considered to be opaque to the client as the server occasionally evolves the meaning of the clockspec and its format is expressly not a stable API.

In particular, there is no defined way for a client to reason about the relationship between any two ClockSpec's.

https://facebook.github.io/watchman/docs/clockspec.html

Variants

StringClock(String)

UnixTimestamp(i64)

Implementations

impl ClockSpec

pub fn null() -> Self

Construct a null clockspec. This indicates a time before any changes occurred and will cause a since generator based query to emit a fresh instance result set that contains all possible matches. It is appropriate to use a null clock in cases where you are starting up from scratch and don't have a saved clock value to use as the basis for your query.

pub fn named_cursor(cursor: &str) -> Self

Construct a named cursor clockspec.

Using a named cursor causes the server to maintain the name -> clock value mapping on the behalf of your tool. This frees your client from the need to manage storing of the clock between queries but does require an exclusive lock for the duration of the query, which serializes the query with all other clients.

The namespace is per watched project so your cursor name must be unique enough to not collide with other tools that use this same feature.

There is no way to clear the value associated with a named cursor.

The first time you use a named cursor, it has an effective value of the null clock.

We do not recommend using named cursors because of the exclusive lock requirement.

pub fn unix_timestamp(time_t: i64) -> Self

A clock specified as a unix timestamp. The watchman server will never generate a clock in this form, but will accept them in since generator based queries. Using UnixTimeStamp is discouraged as it has granularity of 1 second and will often result in over-reporting the same events when they happen in the same second.

Trait Implementations

impl Clone for ClockSpec

fn clone(&self) -> ClockSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClockSpec

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

Formats the value using the given formatter.

impl Default for ClockSpec

Construct a null clockspec

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ClockSpec

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

Deserialize this value from the given Serde deserializer.

impl Into<Value> for ClockSpec

fn into(self) -> Value

Performs the conversion.

impl Serialize for ClockSpec

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

Serialize this value into the given Serde serializer.