Struct anagolay_support::AnagolayStructure

pub struct AnagolayStructure<T: AnagolayStructureData, U: AnagolayStructureExtra> {
    pub id: GenericId,
    pub data: T,
    pub extra: Option<U>,
}

Generic structure representing an Anagolay entity

Fields

id: GenericId

data: T

extra: Option<U>

Implementations

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> AnagolayStructure<T, U>

pub fn new(data: T) -> Self

Produces an Anagolay entity with no extra information

pub fn new_with_extra(data: T, extra: U) -> Self

Produces an Anagolay entity with some extra information

Examples

use codec::{Decode, Encode};
use anagolay_support::{AnagolayStructure, AnagolayStructureData, AnagolayStructureExtra, Characters};

#[derive(Encode, Decode, Clone, PartialEq, Eq)]
struct EntityData {
  text: Vec<u8>
};

impl Default for EntityData {
  fn default() -> Self {
    EntityData {
      text: b"".to_vec()
    }
  }
}

impl AnagolayStructureData for EntityData {
  fn validate(&self) -> Result<(), Characters> {
     Ok(())
  }
}

#[derive(Encode, Decode, Clone, PartialEq, Eq)]
struct EntityExtra {
  created_at: u64
};

impl AnagolayStructureExtra for EntityExtra {}

type Entity = AnagolayStructure<EntityData, EntityExtra>;

let entity = Entity::new_with_extra(EntityData {
  text: b"hello".to_vec()
}, EntityExtra {
  created_at: 0
});

assert_eq!(b"hello".to_vec(), entity.data.text);
assert!(entity.extra.is_some());
assert_eq!(0, entity.extra.unwrap().created_at);

Trait Implementations

impl<T: Clone + AnagolayStructureData, U: Clone + AnagolayStructureExtra> Clone for AnagolayStructure<T, U>

fn clone(&self) -> AnagolayStructure<T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AnagolayStructureData, U: Debug + AnagolayStructureExtra> Debug for AnagolayStructure<T, U>

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

Formats the value using the given formatter.

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> Decode for AnagolayStructure<T, U> where
    T: Decode,
    T: Decode,
    Option<U>: Decode,
    Option<U>: Decode, 

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> Default for AnagolayStructure<T, U>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: AnagolayStructureData, U: AnagolayStructureExtra> Deserialize<'de> for AnagolayStructure<T, U> where
    T: Deserialize<'de>,
    U: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> Encode for AnagolayStructure<T, U> where
    T: Encode,
    T: Encode,
    Option<U>: Encode,
    Option<U>: Encode, 

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: PartialEq + AnagolayStructureData, U: PartialEq + AnagolayStructureExtra> PartialEq<AnagolayStructure<T, U>> for AnagolayStructure<T, U>

fn eq(&self, other: &AnagolayStructure<T, U>) -> bool

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

fn ne(&self, other: &AnagolayStructure<T, U>) -> bool

This method tests for !=.

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> Serialize for AnagolayStructure<T, U> where
    T: Serialize,
    U: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> EncodeLike<AnagolayStructure<T, U>> for AnagolayStructure<T, U> where
    T: Encode,
    T: Encode,
    Option<U>: Encode,
    Option<U>: Encode, 

impl<T: Eq + AnagolayStructureData, U: Eq + AnagolayStructureExtra> Eq for AnagolayStructure<T, U>

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> StructuralEq for AnagolayStructure<T, U>

impl<T: AnagolayStructureData, U: AnagolayStructureExtra> StructuralPartialEq for AnagolayStructure<T, U>