Struct freeform::Freeform

pub struct Freeform(/* private fields */);

Implementations

impl Freeform

pub fn is_empty(&self) -> bool

pub fn new() -> Self

pub fn get_optional<'a, T: Deserialize<'a>>( &'a self, key: Key<T> ) -> Result<Option<T>, FreeformErr>

pub fn get_or_default<'a, T: Deserialize<'a> + Default>( &'a self, key: Key<T> ) -> Result<T, FreeformErr>

pub fn get_required<'a, T: Deserialize<'a>>( &'a self, key: Key<T> ) -> Result<T, FreeformErr>

pub fn get_field_optional<'a, T: Deserialize<'a>>( &'a self, field: &str ) -> Result<Option<T>, FreeformErr>

pub fn get_field_or_default<'a, T: Deserialize<'a> + Default>( &'a self, field: &str ) -> Result<T, FreeformErr>

pub fn get_field_required<'a, T: Deserialize<'a>>( &'a self, field: &str ) -> Result<T, FreeformErr>

pub fn put<T: Serialize, B: Borrow<T>>( &mut self, key: Key<T>, data: B ) -> Result<(), FreeformErr>

pub fn put_field<T: Serialize, B: Borrow<T>>( &mut self, field: &str, data: B ) -> Result<(), FreeformErr>

pub fn put_optional<T: Serialize, O: Borrow<Option<T>>>( &mut self, key: Key<T>, data: O ) -> Result<(), FreeformErr>

Puts the data if the option is Some, else it does nothing

pub fn put_nonempty<T: Serialize, V: Borrow<Vec<T>>>( &mut self, key: Key<Vec<T>>, data: V ) -> Result<(), FreeformErr>

pub fn aggregate<M: IntoIterator<Item = Freeform>>(metadata: M) -> Option<Self>

Trait Implementations

impl Clone for Freeform

fn clone(&self) -> Freeform

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Freeform

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Freeform

fn default() -> Freeform

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Freeform

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<(String, String)> for Freeform

fn extend<T: IntoIterator<Item = (String, String)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Freeform> for HashMap<String, Value>

fn from(metadata: Freeform) -> Self

Converts to this type from the input type.

impl From<HashMap<String, Value>> for Freeform

fn from(map: HashMap<String, Value>) -> Self

Converts to this type from the input type.

impl FromReflect for Freeform

where Self: Any + Send + Sync, HashMap<String, String>: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Freeform

where Self: Any + Send + Sync, HashMap<String, String>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl IntoIterator for Freeform

type IntoIter = IntoIter<String, String>

Which kind of iterator are we turning this into?

type Item = (String, String)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Freeform

fn eq(&self, other: &Freeform) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Freeform

where Self: Any + Send + Sync, HashMap<String, String>: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for Freeform

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TupleStruct for Freeform

where Self: Any + Send + Sync, HashMap<String, String>: FromReflect + TypePath,

fn field(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

impl TypePath for Freeform

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Freeform

where Self: Any + Send + Sync, HashMap<String, String>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for Freeform

impl StructuralPartialEq for Freeform