org.alephium.serde.SerdeError.scala Maven / Gradle / Ivy

Go to download

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

alephium-serde

There is a newer version: 3.7.0

// 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.serde

import org.alephium.util.AppException

sealed abstract class SerdeError(message: String) extends AppException(message)

object SerdeError {
  final case class NotEnoughBytes(message: String) extends SerdeError(message)
  final case class WrongFormat(message: String)    extends SerdeError(message)
  final case class Validation(message: String)     extends SerdeError(message)
  final case class Other(message: String)          extends SerdeError(message)

  // this is returned when deserializing with partial bytes
  def notEnoughBytes(expected: Int, got: Int): NotEnoughBytes =
    NotEnoughBytes(s"Too few bytes: expected $expected, got $got")

  def incompleteData(expected: Int, got: Int): WrongFormat =
    WrongFormat(s"Too few bytes: expected $expected, got $got")

  def redundant(expected: Int, got: Int): WrongFormat =
    WrongFormat(s"Too many bytes: expected $expected, got $got")

  def validation(message: String): Validation = Validation(message)

  def wrongFormat(message: String): WrongFormat = WrongFormat(message)

  def other(message: String): Other = Other(message)
}