bc/
util.rs

1// Bitcoin protocol consensus library.
2//
3// SPDX-License-Identifier: Apache-2.0
4//
5// Written in 2019-2024 by
6//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
7//
8// Copyright (C) 2019-2024 LNP/BP Standards Association. All rights reserved.
9//
10// Licensed under the Apache License, Version 2.0 (the "License");
11// you may not use this file except in compliance with the License.
12// You may obtain a copy of the License at
13//
14//     http://www.apache.org/licenses/LICENSE-2.0
15//
16// Unless required by applicable law or agreed to in writing, software
17// distributed under the License is distributed on an "AS IS" BASIS,
18// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19// See the License for the specific language governing permissions and
20// limitations under the License.
21
22use std::fmt::{Debug, Display};
23
24/// the provided value {value} for {matter} is non-standard; while it is
25/// accepted by the bitcoin consensus rules, the software prohibits from using
26/// it.
27#[derive(Copy, Clone, Eq, PartialEq, Debug, Display, Error)]
28#[display(doc_comments)]
29pub struct NonStandardValue<T: Debug + Display> {
30    pub value: T,
31    pub matter: &'static str,
32}
33
34impl<T: Debug + Display> NonStandardValue<T> {
35    pub const fn with(value: T, matter: &'static str) -> Self { NonStandardValue { value, matter } }
36}