Packages

Tagged, unique ids. K-sortable, based on tagged, base58 encoded UUIDv7 IDs

Current section

Files

Jump to
tuid doc dist search_data-632FDA9E.js
Raw

doc/dist/search_data-632FDA9E.js

searchData={"items":[{"type":"module","title":"TUID","doc":"Documentation for `TUID`.\n\n Generates prefixed base58 encoded UUIDv7.\n\ncredit to blog post:\n\nhttps://danschultzer.com/posts/prefixed-base62-uuidv7-object-ids-with-ecto","ref":"TUID.html"},{"type":"module","title":"TUID.Base58","doc":"`Base58` provides heper functions to encode and decode base58 encoded strings\n\nhttps://en.wikipedia.org/wiki/Binary-to-text_encoding#Base58\n\n\ncredit to blog post:\nhttps://danschultzer.com/posts/prefixed-base62-uuidv7-object-ids-with-ecto","ref":"TUID.Base58.html"},{"type":"function","title":"TUID.Base58.decode/1","doc":"","ref":"TUID.Base58.html#decode/1"},{"type":"function","title":"TUID.Base58.decode_uuid/1","doc":"","ref":"TUID.Base58.html#decode_uuid/1"},{"type":"function","title":"TUID.Base58.encode/1","doc":"","ref":"TUID.Base58.html#encode/1"},{"type":"function","title":"TUID.Base58.encode_uuid/1","doc":"","ref":"TUID.Base58.html#encode_uuid/1"},{"type":"module","title":"TUID.ParameterizedType","doc":"Documentation for `TUID.ParameterizedType`.\n\nParameterizedType implemention for use with Ecto to use TUIDs (tagged, unique ids) as Ecto Types.","ref":"TUID.ParameterizedType.html"},{"type":"function","title":"TUID.ParameterizedType.autogenerate/1","doc":"Generates a loaded version of the data.\n\nThis callback is invoked when a parameterized type is given\nto `field` with the `:autogenerate` flag.","ref":"TUID.ParameterizedType.html#autogenerate/1"},{"type":"function","title":"TUID.ParameterizedType.cast/2","doc":"Casts the given input to the ParameterizedType with the given parameters.\n\nSpecifically, convert a TUID, such as `user_C19xa4ANGXSz72USEyc2m` to a binary UUID for storage into the DB.\n\nFor more information on casting, see `c:Ecto.Type.cast/1`.","ref":"TUID.ParameterizedType.html#cast/2"},{"type":"function","title":"TUID.ParameterizedType.dump/3","doc":"Dumps the given term into an Ecto native type.\n\nIt receives a `dumper` function in case the parameterized\ntype is also a composite type. In order to dump the inner\ntype, the `dumper` must be called with the inner type and\nthe inner value as argument.\n\nFor more information on dumping, see `c:Ecto.Type.dump/1`.\nNote that this callback *will* be called when dumping a `nil`\nvalue, unlike `c:Ecto.Type.dump/1`.","ref":"TUID.ParameterizedType.html#dump/3"},{"type":"function","title":"TUID.ParameterizedType.embed_as/2","doc":"Dictates how the type should be treated inside embeds.\n\nFor more information on embedding, see `c:Ecto.Type.embed_as/1`","ref":"TUID.ParameterizedType.html#embed_as/2"},{"type":"function","title":"TUID.ParameterizedType.equal?/3","doc":"Returns the underlying schema type for the ParameterizedType.\n\nFor more information on schema types, see `c:Ecto.Type.type/0`","ref":"TUID.ParameterizedType.html#equal?/3"},{"type":"function","title":"TUID.ParameterizedType.init/1","doc":"Callback to convert the options specified in the field macro into parameters\nto be used in other callbacks.\n\nThis function is called at compile time, and should raise if invalid values are\nspecified. It is idiomatic that the parameters returned from this are a map.\n`field` and `schema` will be injected into the options automatically.\n\nFor example, this schema specification\n\n schema \"my_table\" do\n field :my_field, MyParameterizedType, opt1: :foo, opt2: nil\n end\n\nwill result in the call:\n\n MyParameterizedType.init([schema: \"my_table\", field: :my_field, opt1: :foo, opt2: nil])","ref":"TUID.ParameterizedType.html#init/1"},{"type":"function","title":"TUID.ParameterizedType.load/3","doc":"Loads the given term into a ParameterizedType.\n\nIt receives a `loader` function in case the parameterized\ntype is also a composite type. In order to load the inner\ntype, the `loader` must be called with the inner type and\nthe inner value as argument.\n\nFor more information on loading, see `c:Ecto.Type.load/1`.\nNote that this callback *will* be called when loading a `nil`\nvalue, unlike `c:Ecto.Type.load/1`.","ref":"TUID.ParameterizedType.html#load/3"}],"content_type":"text/markdown"}