Struct CollectionSchema

pub struct CollectionSchema {
    pub name: String,
    pub is_edge_collection: bool,
    pub wait_for_sync: Option<bool>,
}

Aragog schema representation of an ArangoDB Collection. This struct is meant to load/generate the schema file.

Fields

name: String

Collection name

is_edge_collection: bool

Defines if the collection a edge collection

wait_for_sync: Option<bool>

Defines if the collection requests wait for the operations to be written on disk

If set on true the requests might be slower. By default, false is used

Implementations

impl CollectionSchema

pub fn new( name: &str, is_edge_collection: bool, wait_for_sync: Option<bool>, ) -> Self

Initializes a new collection schema with the collection name and a flag to define if it’s an edge collection or not.

Trait Implementations

impl Clone for CollectionSchema

fn clone(&self) -> CollectionSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl SchemaDatabaseOperation for CollectionSchema

type PoolType = Collection

The arangors_lite type to retrieve with the get method

fn apply_to_database<'life0, 'life1, 'async_trait>( &'life0 self, database: &'life1 Database, silent: bool, ) -> Pin<Box<dyn Future<Output = Result<Option<Self::PoolType>, ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Applies (creates) the schema element to the database

fn drop<'life0, 'life1, 'async_trait>( &'life0 self, database: &'life1 Database, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deletes the schema element from the database.

fn get<'life0, 'life1, 'async_trait>( &'life0 self, database: &'life1 Database, ) -> Pin<Box<dyn Future<Output = Result<Self::PoolType, ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves the arangors_lite element from the schema element

fn handle_error<T>( result: Result<T, ClientError>, silent: bool, ) -> Result<(), ClientError>

Utility method to allow “silent” error handling

fn handle_pool_result( result: Result<Self::PoolType, ClientError>, silent: bool, ) -> Result<Option<Self::PoolType>, ClientError>

Factorisation of result and error handling for schema operations

impl Serialize for CollectionSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.