scale-info 0.4.1

// Copyright 2019-2020 Parity Technologies (UK) Ltd.
//
// 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 crate::tm_std::*;

use crate::{
	form::{CompactForm, Form, MetaForm},
	Field, IntoCompact, Registry,
};
use derive_more::From;
use scale::{Decode, Encode};
use serde::{de::DeserializeOwned, Deserialize, Serialize};

/// A composite type, consisting of either named (struct) or unnamed (tuple
/// struct) fields
///
/// # Examples
///
/// ## A Rust struct with named fields.
///
/// ```
/// struct Person {
///     name: String,
///     age_in_years: u8,
///     friends: Vec<Person>,
/// }
/// ```
///
/// ## A tuple struct with unnamed fields.
///
/// ```
/// struct Color(u8, u8, u8);
/// ```
///
/// ## A so-called unit struct
///
/// ```
/// struct JustAMarker;
/// ```
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug, From, Serialize, Deserialize, Encode, Decode)]
#[serde(bound(
	serialize = "T::Type: Serialize, T::String: Serialize",
	deserialize = "T::Type: DeserializeOwned, T::String: DeserializeOwned"
))]
#[serde(rename_all = "lowercase")]
pub struct TypeDefComposite<T: Form = MetaForm> {
	/// The fields of the composite type.
	#[serde(skip_serializing_if = "Vec::is_empty", default)]
	fields: Vec<Field<T>>,
}

impl IntoCompact for TypeDefComposite {
	type Output = TypeDefComposite<CompactForm>;

	fn into_compact(self, registry: &mut Registry) -> Self::Output {
		TypeDefComposite {
			fields: registry.map_into_compact(self.fields),
		}
	}
}

impl TypeDefComposite {
	/// Creates a new struct definition with named fields.
	pub fn new<I>(fields: I) -> Self
	where
		I: IntoIterator<Item = Field>,
	{
		Self {
			fields: fields.into_iter().collect(),
		}
	}
}

impl<T> TypeDefComposite<T>
where
	T: Form,
{
	/// Returns the fields of the composite type.
	pub fn fields(&self) -> &[Field<T>] {
		&self.fields
	}
}