Skip to content

Latest commit

 

History

History
114 lines (84 loc) · 3.29 KB

README.md

File metadata and controls

114 lines (84 loc) · 3.29 KB
Raw

Deser nim-version-img

Serde-like de/serialization library for Nim.

nimble install deser

Documentation

Motivation Many serializers have already been written for Nim. You can probably find at least two serializers for each format.

The problem is that each library's API and customization options are different. I can't declare an object with renamed or skipped fields once and change the data format with one line.

Attempts to generalize the serializer were also made. However, I found only one library that is actively under development - nim-serialization. When installing the library downloaded a quarter of all libraries for Nim, so I did not try it.

Thus, there was no library for Nim that standardized the serialization process, so I wrote deser.

Also read:

Supported formats

Also read:

Example

import std/[
  options,
  times
]

import
  deser,
  deser_json

proc fromTimestamp(deserializer: var auto): Time =
  fromUnix(deserialize(int64, deserializer))

proc toTimestamp(self: Time, serializer: var auto) =
  serializer.serializeInt64(self.toUnix())

type
  ChatType = enum
    Private = "private"
    Group = "group"

  Chat {.renameAll(SnakeCase).} = object
    id: int64
    username {.skipSerializeIf(isNone).}: Option[string]
    created {.serializeWith(toTimestamp), deserializeWith(fromTimestamp).}: Time

    case kind {.renamed("type").}: ChatType
    of Private:
      firstName: string
      lastName {.skipSerializeIf(isNone).}: Option[string]
      bio {.skipSerializeIf(isNone).}: Option[string]
    of Group:
      title: string

# Use public to export deserialize or serialize procedures
# false by default
makeSerializable(Chat, public=true)
makeDeserializable(Chat, public=true)

const
  json = """
  {
    "id": 123,
    "username": "gabbhack",
    "created": 1234567890,
    "type": "private",
    "first_name": "Gabben"
  }
  """
  chat = Chat(
    id: 123,
    username: some "gabbhack",
    created: fromUnix(1234567890),
    kind: Private,
    firstName: "Gabben"
  )

echo Chat.fromJson(json)
echo chat.toJson()

Also read:

License

Licensed under MIT license.

Deser uses third-party libraries or other resources that may be distributed under licenses different than the deser.

THIRD-PARTY-NOTICES.TXT

Acknowledgements