struct UUID

• UUID
• Struct
• Value
• Object

Overview

Represents a UUID (Universally Unique IDentifier).

Defined in:

Constructors

• .new(bytes : StaticArray(UInt8, 16), variant : UUID::Variant? = nil, version : UUID::Version? = nil)

  Generates UUID from bytes, applying version and variant to the UUID if present.

• .new(slice : Slice(UInt8), variant = nil, version = nil)

  Creates UUID from 16-bytes slice.

• .new(uuid : UUID, variant = nil, version = nil)

  Creates another UUID which is a copy of uuid, but allows overriding variant or version.

• .new(value : String, variant = nil, version = nil)

  Creates new UUID by decoding value string from hyphenated (ie.

• .new(pull : JSON::PullParser)

  Creates UUID from JSON using JSON::PullParser.

Class Method Summary

• .empty
• .random(random = Random::Secure, variant = Variant::RFC4122, version = Version::V4)

  Generates RFC 4122 v4 UUID.

Instance Method Summary

• #==(other : UUID)

  Returns true if other UUID represents the same UUID, false otherwise.

• #bytes : StaticArray(UInt8, 16)

  Returns the binary representation of the UUID.

• #hexstring
• #inspect(io : IO) : Nil

  Convert to String in literal format.

• #to_json(json : JSON::Builder)

  Returns UUID as JSON value.

• #to_s(io : IO) : Nil

  Same as #inspect(io).

• #to_unsafe

  Returns unsafe pointer to 16-bytes.

• #urn
• #v1!

  Returns true if UUID is a V1, raises Error otherwise.

• #v1?

  Returns true if UUID is a V1, false otherwise.

• #v2!

  Returns true if UUID is a V2, raises Error otherwise.

• #v2?

  Returns true if UUID is a V2, false otherwise.

• #v3!

  Returns true if UUID is a V3, raises Error otherwise.

• #v3?

  Returns true if UUID is a V3, false otherwise.

• #v4!

  Returns true if UUID is a V4, raises Error otherwise.

• #v4?

  Returns true if UUID is a V4, false otherwise.

• #v5!

  Returns true if UUID is a V5, raises Error otherwise.

• #v5?

  Returns true if UUID is a V5, false otherwise.

• #variant

  Returns UUID variant.

• #version

  Returns version based on RFC4122 format.

Constructor Detail

require "json"
require "uuid"
require "uuid/json"

class Example
  include JSON::Serializable

  property id : UUID
end

example = Example.from_json(%({"id": "ba714f86-cac6-42c7-8956-bcf5105e1b81"}))
example.id # => UUID(ba714f86-cac6-42c7-8956-bcf5105e1b81)

Class Method Detail

Instance Method Detail

uuid = UUID.new("87b3042b-9b9a-41b7-8b15-a93d3f17025e")
uuid.to_json # => "\"87b3042b-9b9a-41b7-8b15-a93d3f17025e\""