Struct rincon_client::collection::methods::CreateCollection

pub struct CreateCollection { /* fields omitted */ }

Creates a new collection with the given name.

Methods

impl CreateCollection

pub fn new(collection: NewCollection) -> Self

Constructs a new instance of the CreateCollection method with the given NewCollection parameters.

pub fn with_name<N>(name: N) -> Self where
    N: Into<String>, 

Constructs a new instance of the CreateCollection method that will create a new collection with the given name and the default collection type. The default collection type is defined by the ArangoDB server.

All other parameters will be set to their default values.

pub fn documents_with_name<N>(name: N) -> Self where
    N: Into<String>, 

Constructs a new instance of the CreateCollection method that will create a new documents collection with the given name.

All other parameters will be set to their default values.

pub fn edges_with_name<N>(name: N) -> Self where
    N: Into<String>, 

Constructs a new instance of the CreateCollection method that will create a new edge collection with the given name.

All other parameters will be set to their default values.

pub fn set_wait_for_sync_replication(&mut self, wait_for_sync_replication: bool)

Set whether the server shall wait until the new collection has been created at all replications before it returns the response.

pub fn collection(&self) -> &NewCollection

Returns the parameters that are going to be used to create the new collection.

pub fn is_wait_for_sync_replication(&self) -> bool

Returns whether the request will wait until the new collection has been created at all replications.

Trait Implementations

impl Debug for CreateCollection

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for CreateCollection

fn clone(&self) -> CreateCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for CreateCollection

fn eq(&self, __arg_0: &CreateCollection) -> bool

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

fn ne(&self, __arg_0: &CreateCollection) -> bool

This method tests for !=.

impl Method for CreateCollection

type Result = BasicCollectionProperties

The type of the result of a method call.

const RETURN_TYPE: RpcReturnType

RETURN_TYPE: RpcReturnType = RpcReturnType{result_field: None, code_field: Some(FIELD_CODE),}

Specification of the fields of RPC-like return type.

fn return_type(&self) -> RpcReturnType

Returns the specification of the RPC-like return type.

impl Prepare for CreateCollection

type Content = NewCollection

The type of the content of a method call.

fn operation(&self) -> Operation

Returns the type of operation this method is executing.

fn path(&self) -> String

Returns the resource path of a REST operation.

fn parameters(&self) -> Parameters

Returns the query parameters of this method.

fn header(&self) -> Parameters

Returns the header parameters of this method.

fn content(&self) -> Option<&Self::Content>

Returns the content of this method if any.