Struct aragog::EdgeRecord

pub struct EdgeRecord<T> {
    pub data: T,
    /* private fields */
}

Struct wrapping an edge document, with the from and to fields correctly set.

The document of type T mut implement Record and EdgeRecord also implements it.

Note

EdgeRecord implements Deref and DerefMut into T

Fields

data: T

The main document data, must implement Record.

Note: The data is flattened on save, so you won’t have any field named data in your database.

Implementations

impl<T: Record> EdgeRecord<T>

pub fn new(id_from: String, id_to: String, data: T) -> Result<Self, Error>

Manually instantiates an Edge record

Arguments

• id_from - The from document id
• id_to - The to document id
• data - The main document data

Errors

This function validates the format of the id fields which can result in an error.

pub async fn from_record<D, R>( &self, db_access: &D ) -> Result<DatabaseRecord<R>, Error>where D: DatabaseAccess + ?Sized, R: Record,

Retrieves the from document from the database

pub async fn to_record<D, R>( &self, db_access: &D ) -> Result<DatabaseRecord<R>, Error>where D: DatabaseAccess + ?Sized, R: Record,

Retrieves the to document from the database

pub fn id_from(&self) -> &String

Retrieves the document _from field, storing the target documents id.

pub fn id_to(&self) -> &String

Retrieves the document _to field, storing the target documents id.

pub fn key_from(&self) -> &str

Parses the from value to retrieve only the _key part.

Panics

This method may panic if the from value is not formatted correctly.

pub fn key_to(&self) -> &str

Parses the to value to retrieve only the _key part.

Panics

This method may panic if the to value is not formatted correctly.

pub fn to_collection_name(&self) -> String

Parses the from value to retrieve only the collection name part.

Panics

This method may panic if the to value is not formatted correctly.

pub fn from_collection_name(&self) -> &str

Parses the to value to retrieve only the collection name part.

Panics

This method may panic if the from value is not formatted correctly.

Trait Implementations

impl<T: Clone> Clone for EdgeRecord<T>

fn clone(&self) -> EdgeRecord<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Record> Deref for EdgeRecord<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Record> DerefMut for EdgeRecord<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for EdgeRecord<T>where T: 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: Record + Send> Record for EdgeRecord<T>

const COLLECTION_NAME: &'static str = T::COLLECTION_NAME

returns the associated Collection for read and write operations.

fn before_create_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

method called by DatabaseRecord::create before the database operation.

fn before_save_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

method called by DatabaseRecord::save before the database operation.

fn before_delete_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

method called by DatabaseRecord::delete before the database operation.

fn after_create_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

method called automatically by DatabaseRecord::create after the database operation.

fn after_save_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

method called automatically by DatabaseRecord::save after the database operation.

fn after_delete_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

method called automatically by DatabaseRecord::delete after the database operation.

fn find<'life0, 'life1, 'async_trait, D>( key: &'life0 str, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<DatabaseRecord<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Finds a document in database from its unique key. Simple wrapper for DatabaseRecord<T>::find

fn get<'life0, 'life1, 'async_trait, D>( query: &'life0 Query, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<QueryResult<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Finds all documents in database matching a Query. Simple wrapper for DatabaseRecord<T>::get

fn get_in_batches<'life0, 'life1, 'async_trait, D>( query: &'life0 Query, db_accessor: &'life1 D, batch_size: u32 ) -> Pin<Box<dyn Future<Output = Result<QueryCursor<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Finds all documents in database matching a Query in batches. Simple wrapper for DatabaseRecord<T>::get_in_batches

fn exists<'life0, 'life1, 'async_trait, D>( query: &'life0 Query, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns true if there are any document in database matching a Query. Simple wrapper for DatabaseRecord<T>::exists

fn create<'life0, 'async_trait, D>( record: Self, db_accessor: &'life0 D ) -> Pin<Box<dyn Future<Output = Result<DatabaseRecord<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait,

Creates a new document in database. Simple wrapper for DatabaseRecord<T>::create

fn query() -> Query

Creates a new Query instance for Self.

fn transaction_builder() -> TransactionBuilder

Returns a transaction builder on this collection only.

fn transaction<'life0, 'async_trait>( db_connection: &'life0 DatabaseConnection ) -> Pin<Box<dyn Future<Output = Result<Transaction, Error>> + Send + 'async_trait>>where Self: Send + 'async_trait, 'life0: 'async_trait,

Builds a transaction for this collection only.

impl<T> Serialize for EdgeRecord<T>where T: 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: Record> Validate for EdgeRecord<T>

fn validations(&self, errors: &mut Vec<String>)

Runs all the defined validation on fields and fills the errors string vector with custom error messages

fn validate(&self) -> Result<(), Error>

Validates the object field formats, logic or anything.

fn is_valid(&self) -> bool

Runs all validations and returns a false if they failed, on success true is returned

fn validate_field_presence<T>( field_name: &str, field: &Option<T>, errors: &mut Vec<String> ) -> bool

Helper function to simply check the presence of a field. This function is usually used inside the validations method since it will fill the errors with a message if the field is missing.

fn validate_field_absence<T>( field_name: &str, field: &Option<T>, errors: &mut Vec<String> ) -> bool

Helper function to simply check the absence of a field. This function is usually used inside the validations method since it will fill the errors with a message if the field is missing.

fn validate_numeric_string( field_path: &str, str: &str, errors: &mut Vec<String> ) -> bool

Validates that str is numeric. Usually used as a helper function for implementations of Validate trait.

fn validate_max_len( field_path: &str, str: &str, max_len: usize, errors: &mut Vec<String> ) -> bool

Validates that str is not longer than expected. Usually used as a helper function for implementations of Validate trait.

fn validate_min_len( field_path: &str, str: &str, min_len: usize, errors: &mut Vec<String> ) -> bool

Validates that str is not shorter than expected. Usually used as a helper function for implementations of Validate trait.

fn validate_len( field_path: &str, str: &str, len: usize, errors: &mut Vec<String> ) -> bool

Validates that str has the exact expected length. Usually used as a helper function for implementations of Validate trait.

fn validate_max_count<T>( field_path: &str, field_value: Iter<'_, T>, max_count: usize, errors: &mut Vec<String> ) -> bool

Validates the maximum number of elements in field_value. Usually used as a helper function for implementations of Validate trait.

fn validate_min_count<T>( field_path: &str, field_value: Iter<'_, T>, min_count: usize, errors: &mut Vec<String> ) -> bool

Validates the minimum number of elements in field_value. Usually used as a helper function for implementations of Validate trait.

fn validate_count<T>( field_path: &str, field_value: Iter<'_, T>, count: usize, errors: &mut Vec<String> ) -> bool

Validates the exact number of elements in field_value. Usually used as a helper function for implementations of Validate trait.

fn validate_regex( field_path: &str, str: &str, regex: &str, errors: &mut Vec<String> ) -> bool

Validates that str matches a regexp. Usually used as a helper function for implementations of Validate trait.

fn validate_greater_than<T: PartialOrd + Display>( field_path: &str, value: T, min_value: T, errors: &mut Vec<String> ) -> bool

Validates that value is greater than min_value. Usually used as a helper function for implementations of Validate trait.

fn validate_greater_or_equal_to<T: PartialOrd + Display>( field_path: &str, value: T, min_value: T, errors: &mut Vec<String> ) -> bool

Validates that value is greater or equal to min_value. Usually used as a helper function for implementations of Validate trait.

fn validate_lesser_than<T: PartialOrd + Display>( field_path: &str, value: T, max_value: T, errors: &mut Vec<String> ) -> bool

Validates that value is lower than max_value. Usually used as a helper function for implementations of Validate trait.

fn validate_lesser_or_equal_to<T: PartialOrd + Display>( field_path: &str, value: T, max_value: T, errors: &mut Vec<String> ) -> bool

Validates that value is lower or equal to max_value. Usually used as a helper function for implementations of Validate trait.

const SIMPLE_EMAIL_REGEX: &'static str = r#"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}"#

A simple and fast regular expression to validate email formats

const RFC_5322_EMAIL_REGEX: &'static str = r#"(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])"#

RFC 5322 compliant regular expression to validate email formats from emailregex.com. It is significantly slower than the simple_email_regex