1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
// Strict encoding library for deterministic binary serialization.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2019-2023 by
// Dr. Maxim Orlovsky <orlovsky@ubideco.org>
//
// Copyright 2022-2023 UBIDECO Institute
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::io;
use std::ops::Range;
use amplify::{confinement, IoError};
#[derive(Clone, Eq, PartialEq, Debug, Display, Error, From)]
#[display(doc_comments)]
pub enum DecodeError {
#[display(inner)]
#[from(io::Error)]
Io(IoError),
/// confinement requirements are not satisfied. Specifically, {0}
#[from]
Confinement(confinement::Error),
/// string data are not in valid UTF-8 encoding.\nDetails: {0}
#[from]
Utf8(std::string::FromUtf8Error),
/// string data are not in valid UTF-8 encoding.\nDetails: {0}
#[from]
Ascii(amplify::ascii::AsAsciiStrError),
/// value occurs multiple times in a set
RepeatedSetValue,
/// key occurs multiple times in a map
RepeatedMapValue,
/// unsupported value `{1}` for enum `{0}` encountered during decode
/// operation
EnumValueNotKnown(String, u8),
/// unsupported value `{1}` for union `{0}` encountered during decode
/// operation
UnionValueNotKnown(String, u8),
/// decoding resulted in value `{2}` for type `{0}` that exceeds the
/// supported range {1:#?}
ValueOutOfRange(String, Range<u128>, u128),
/// encoded values are not deterministically ordered within a set
BrokenSetOrder,
/// encoded map has wrong order of keys
BrokenMapOrder,
/// data integrity problem during strict decoding operation.\nDetails: {0}
DataIntegrityError(String),
}
#[derive(Clone, Eq, PartialEq, Debug, Display, Error, From)]
#[display(doc_comments)]
pub enum SerializeError {
#[display(inner)]
#[from(io::Error)]
Io(IoError),
/// confinement requirements are not satisfied. Specifically, {0}
#[from]
Confinement(confinement::Error),
}
#[derive(Clone, Eq, PartialEq, Debug, Display, Error, From)]
#[display(doc_comments)]
pub enum DeserializeError {
#[display(inner)]
#[from]
#[from(io::Error)]
Decode(DecodeError),
/// data are not entirely consumed during strict deserialize operation
DataNotEntirelyConsumed,
}