org.alephium.protocol.SafeSerde.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alephium-protocol_2.13 Show documentation

alephium-protocol

There is a newer version: 3.8.8

Show newest version

// Copyright 2018 The Alephium Authors
// This file is part of the alephium project.
//
// The library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the library. If not, see .

package org.alephium.protocol

import akka.util.ByteString

import org.alephium.serde.{Serde, SerdeError, SerdeResult, Serializer, Staging}

trait SafeSerde[T, Config] {
  def serialize(t: T): ByteString

  def _deserialize(input: ByteString)(implicit config: Config): SerdeResult[Staging[T]]

  def deserialize(input: ByteString)(implicit config: Config): SerdeResult[T] = {
    _deserialize(input).flatMap { case Staging(output, rest) =>
      if (rest.isEmpty) {
        Right(output)
      } else {
        Left(SerdeError.redundant(input.size - rest.size, input.size))
      }
    }
  }
}

trait SafeSerdeImpl[T, Config] extends SafeSerde[T, Config] {
  def unsafeSerde: Serde[T]

  implicit def serializer: Serializer[T] = unsafeSerde

  def validate(t: T)(implicit config: Config): Either[String, Unit]

  def serialize(t: T): ByteString = unsafeSerde.serialize(t)

  def _deserialize(input: ByteString)(implicit config: Config): SerdeResult[Staging[T]] = {
    unsafeSerde._deserialize(input).flatMap { case Staging(t, rest) =>
      validate(t) match {
        case Right(_)    => Right(Staging(t, rest))
        case Left(error) => Left(SerdeError.validation(error))
      }
    }
  }
}