neo-types 0.14.0

Neo N3 Core Types for Smart Contract Development
Documentation
// Copyright (c) 2025-2026 R3E Network
// Licensed under the MIT License

use crate::array::NeoArray;
use crate::boolean::NeoBoolean;
use crate::bytestring::NeoByteString;
use crate::integer::NeoInteger;
use crate::map::NeoMap;
use crate::string::NeoString;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

// Standard library imports - grouped together
use std::string::String;
use std::vec::Vec;

/// Neo N3 Struct type
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct NeoStruct {
    fields: Vec<(String, NeoValue)>,
}

impl NeoStruct {
    pub fn new() -> Self {
        Self { fields: Vec::new() }
    }

    pub fn with_field(mut self, name: &str, value: NeoValue) -> Self {
        self.fields.push((name.to_string(), value));
        self
    }

    pub fn get_field(&self, name: &str) -> Option<&NeoValue> {
        self.fields
            .iter()
            .find(|(field_name, _)| field_name == name)
            .map(|(_, value)| value)
    }

    pub fn set_field(&mut self, name: &str, value: NeoValue) {
        if let Some((_, field_value)) = self
            .fields
            .iter_mut()
            .find(|(field_name, _)| field_name == name)
        {
            *field_value = value;
        } else {
            self.fields.push((name.to_string(), value));
        }
    }

    pub fn insert(&mut self, name: NeoString, value: NeoValue) {
        self.set_field(name.as_str(), value);
    }

    pub fn len(&self) -> usize {
        self.fields.len()
    }

    pub fn is_empty(&self) -> bool {
        self.fields.is_empty()
    }

    pub fn iter(&self) -> impl Iterator<Item = (&str, &NeoValue)> {
        self.fields
            .iter()
            .map(|(name, value)| (name.as_str(), value))
    }
}

impl Default for NeoStruct {
    fn default() -> Self {
        Self::new()
    }
}

/// Neo N3 Value type (union of all Neo types)
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum NeoValue {
    Integer(NeoInteger),
    Boolean(NeoBoolean),
    ByteString(NeoByteString),
    String(NeoString),
    Array(NeoArray<NeoValue>),
    Map(NeoMap<NeoValue, NeoValue>),
    Struct(NeoStruct),
    Null,
}

impl NeoValue {
    pub fn is_null(&self) -> bool {
        matches!(self, NeoValue::Null)
    }

    pub fn as_integer(&self) -> Option<&NeoInteger> {
        match self {
            NeoValue::Integer(i) => Some(i),
            _ => None,
        }
    }

    pub fn as_boolean(&self) -> Option<NeoBoolean> {
        match self {
            NeoValue::Boolean(b) => Some(*b),
            _ => None,
        }
    }

    pub fn as_byte_string(&self) -> Option<&NeoByteString> {
        match self {
            NeoValue::ByteString(bs) => Some(bs),
            _ => None,
        }
    }

    pub fn as_string(&self) -> Option<&NeoString> {
        match self {
            NeoValue::String(s) => Some(s),
            _ => None,
        }
    }

    pub fn as_array(&self) -> Option<&NeoArray<NeoValue>> {
        match self {
            NeoValue::Array(a) => Some(a),
            _ => None,
        }
    }

    pub fn as_map(&self) -> Option<&NeoMap<NeoValue, NeoValue>> {
        match self {
            NeoValue::Map(m) => Some(m),
            _ => None,
        }
    }

    pub fn as_struct(&self) -> Option<&NeoStruct> {
        match self {
            NeoValue::Struct(s) => Some(s),
            _ => None,
        }
    }
}

impl From<NeoInteger> for NeoValue {
    fn from(value: NeoInteger) -> Self {
        NeoValue::Integer(value)
    }
}

impl From<i64> for NeoValue {
    fn from(value: i64) -> Self {
        NeoValue::Integer(NeoInteger::new(value))
    }
}

impl From<NeoBoolean> for NeoValue {
    fn from(value: NeoBoolean) -> Self {
        NeoValue::Boolean(value)
    }
}

impl From<bool> for NeoValue {
    fn from(value: bool) -> Self {
        NeoValue::Boolean(NeoBoolean::new(value))
    }
}

impl From<NeoByteString> for NeoValue {
    fn from(value: NeoByteString) -> Self {
        NeoValue::ByteString(value)
    }
}

impl From<NeoString> for NeoValue {
    fn from(value: NeoString) -> Self {
        NeoValue::String(value)
    }
}

impl From<NeoArray<NeoValue>> for NeoValue {
    fn from(value: NeoArray<NeoValue>) -> Self {
        NeoValue::Array(value)
    }
}

impl From<NeoMap<NeoValue, NeoValue>> for NeoValue {
    fn from(value: NeoMap<NeoValue, NeoValue>) -> Self {
        NeoValue::Map(value)
    }
}

impl From<NeoStruct> for NeoValue {
    fn from(value: NeoStruct) -> Self {
        NeoValue::Struct(value)
    }
}