Struct TimerId 

pub struct TimerId(/* private fields */);

Unique timer identifier.

Timer IDs are monotonically increasing and never reused within a session. This follows the same pattern as TaskId and BufferId.

Example

use reovim_kernel::api::v1::*;

let id1 = TimerId::new();
let id2 = TimerId::new();
assert_ne!(id1, id2);
assert!(id2.as_u64() > id1.as_u64());

Implementations

impl TimerId

pub fn new() -> Self

Create a new unique timer ID.

IDs start at 1 and increment monotonically.

pub const fn as_u64(self) -> u64

Get the raw numeric value.

pub const fn from_raw(value: u64) -> Self

Create from raw value.

Primarily for testing and deserialization.

Trait Implementations

impl Clone for TimerId

fn clone(&self) -> TimerId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimerId

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

Formats the value using the given formatter.

impl Default for TimerId

fn default() -> Self

Returns the “default value” for a type.

impl Display for TimerId

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

Formats the value using the given formatter.

impl Hash for TimerId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TimerId

fn cmp(&self, other: &TimerId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TimerId

fn eq(&self, other: &TimerId) -> 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 PartialOrd for TimerId

fn partial_cmp(&self, other: &TimerId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TimerId

impl Eq for TimerId

impl StructuralPartialEq for TimerId