surrealdb-types 3.0.5

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation
use std::ops::{Deref, DerefMut};

use serde::{Deserialize, Serialize};

use crate::sql::{SqlFormat, ToSql};
use crate::{SurrealValue, Value};

/// Represents an array of values in SurrealDB
///
/// An array is an ordered collection of values that can contain elements of any type.
/// The underlying storage is a `Vec<Value>`.

#[derive(Clone, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize, Deserialize)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub struct Array(pub(crate) Vec<Value>);

impl Array {
	/// Create a new empty array
	pub fn new() -> Self {
		Array(Vec::new())
	}

	/// Create a new array with capacity
	pub fn with_capacity(len: usize) -> Self {
		Self(Vec::with_capacity(len))
	}

	/// Convert the array into a vector of values.
	pub fn into_vec(self) -> Vec<Value> {
		self.0
	}

	/// Convert into the inner `Vec<Value>`
	pub fn into_inner(self) -> Vec<Value> {
		self.0
	}
}

impl<T: SurrealValue> From<Vec<T>> for Array {
	fn from(v: Vec<T>) -> Self {
		v.into_iter().map(T::into_value).collect()
	}
}

impl From<Array> for Vec<Value> {
	fn from(s: Array) -> Self {
		s.0
	}
}

impl<T: SurrealValue> FromIterator<T> for Array {
	fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
		Array(iter.into_iter().map(T::into_value).collect())
	}
}

impl Deref for Array {
	type Target = Vec<Value>;
	fn deref(&self) -> &Self::Target {
		&self.0
	}
}

impl DerefMut for Array {
	fn deref_mut(&mut self) -> &mut Self::Target {
		&mut self.0
	}
}

impl IntoIterator for Array {
	type Item = Value;
	type IntoIter = std::vec::IntoIter<Self::Item>;
	fn into_iter(self) -> Self::IntoIter {
		self.0.into_iter()
	}
}

impl<'a> IntoIterator for &'a Array {
	type Item = &'a Value;
	type IntoIter = std::slice::Iter<'a, Value>;
	fn into_iter(self) -> Self::IntoIter {
		self.0.iter()
	}
}

impl<'a> IntoIterator for &'a mut Array {
	type Item = &'a mut Value;
	type IntoIter = std::slice::IterMut<'a, Value>;
	fn into_iter(self) -> Self::IntoIter {
		self.0.iter_mut()
	}
}

impl ToSql for Array {
	fn fmt_sql(&self, f: &mut String, fmt: SqlFormat) {
		use crate::sql::fmt_sql_comma_separated;

		f.push('[');
		if !self.is_empty() {
			let inner_fmt = fmt.increment();
			fmt_sql_comma_separated(&self.0, f, inner_fmt);
		}
		f.push(']');
	}
}