# std/oids

Dark Mode

- Manual
- Standard library
- Index
- Compiler docs
- Fusion docs
- devel, stable

Search:
Source Edit

Nim OID support. An OID is a global ID that consists of a timestamp, a unique counter and a random value. This combination should suffice to produce a globally distributed unique ID. This implementation was extracted from the MongoDB interface and is thus binary compatible with a MongoDB OID.

This implementation calls `initRand()` for the first call of `genOid`.

# Imports

hashes, times, endians, random, decode_helpers

# Types

    Oid = object
      time: int32
      fuzz: int32
      count: int32

  An OID. Source Edit

# Procs

    proc `$`(oid: Oid): string {....raises: [], tags: [].}

  Converts an OID to a string. Source Edit

    proc `==`(oid1: Oid; oid2: Oid): bool {.inline, ...raises: [], tags: [].}

  Compares two OIDs for equality. Source Edit

    proc generatedTime(oid: Oid): Time {....raises: [], tags: [].}

  Returns the generated timestamp of the OID. Source Edit

    proc genOid(): Oid {....raises: [], tags: [TimeEffect].}

  Generates a new OID.

  Example:

      doAssert ($genOid()).len == 24

  Example: cmd: -r:off

      echo $genOid() # for example, "5fc7f546ddbbc84800006aaf"

  Source Edit

    proc hash(oid: Oid): Hash {....raises: [], tags: [].}

  Generates the hash of an OID for use in hashtables. Source Edit

    proc hexbyte(hex: char): int {.inline, ...raises: [], tags: [].}

  Source Edit

    proc oidToString(oid: Oid; str: cstring) {....deprecated: "unsafe; use `$`",
        raises: [], tags: [].}

  Deprecated: unsafe; use `$`
  Converts an oid to a string which must have space allocated for 25 elements. Source Edit

    proc parseOid(str: cstring): Oid {....raises: [], tags: [].}

  Parses an OID. Source Edit