Struct rincon_client::collection::methods::ChangeCollectionProperties

pub struct ChangeCollectionProperties { /* fields omitted */ }

Change the properties of a collection identified by name.

With this method only the properties wait_for_sync, journal_size (for MMFiles DB) can be changed.

To change the name of a collection, rename the collection using the RenameCollection method.

All other collection properties can not be changed once the collection is created.

Methods

impl ChangeCollectionProperties

pub fn new(name: String, updates: CollectionPropertiesUpdate) -> Self

Constructs a new instance of the ChangeCollectionProperties method.

The name parameter must contain the name of the collection for which the properties shall be changed. The updates parameter contains the actual changes that shall be applied.

pub fn name(&self) -> &str

Returns the name of the collection for which the properties shall be changed.

pub fn updates(&self) -> &CollectionPropertiesUpdate

Returns the updates that shall be applied to the collection's properties.

Trait Implementations

impl Debug for ChangeCollectionProperties

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

Formats the value using the given formatter.

impl Clone for ChangeCollectionProperties

fn clone(&self) -> ChangeCollectionProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for ChangeCollectionProperties

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

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

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

This method tests for !=.

impl Method for ChangeCollectionProperties

type Result = CollectionProperties

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 ChangeCollectionProperties

type Content = CollectionPropertiesUpdate

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.