Struct polodb_core::Collection
source · pub struct Collection<T> { /* private fields */ }
Expand description
A wrapper of collection in struct.
All CURD methods can be done through this structure.
It can be used to perform collection-level operations such as CRUD operations.
Implementations§
source§impl<T> Collection<T>
impl<T> Collection<T>
pub fn name(&self) -> &str
sourcepub fn count_documents(&self) -> DbResult<u64>
pub fn count_documents(&self) -> DbResult<u64>
Return the size of all data in the collection.
sourcepub fn count_documents_with_session(
&self,
session: &mut ClientSession
) -> DbResult<u64>
pub fn count_documents_with_session( &self, session: &mut ClientSession ) -> DbResult<u64>
Return the size of all data in the collection.
sourcepub fn update_one(
&self,
query: Document,
update: Document
) -> DbResult<UpdateResult>
pub fn update_one( &self, query: Document, update: Document ) -> DbResult<UpdateResult>
Updates up to one document matching query
in the collection.
documentation for more information on specifying updates.
sourcepub fn update_one_with_session(
&self,
query: Document,
update: Document,
session: &mut ClientSession
) -> DbResult<UpdateResult>
pub fn update_one_with_session( &self, query: Document, update: Document, session: &mut ClientSession ) -> DbResult<UpdateResult>
Updates up to one document matching query
in the collection.
documentation for more information on specifying updates.
sourcepub fn update_many(
&self,
query: Document,
update: Document
) -> DbResult<UpdateResult>
pub fn update_many( &self, query: Document, update: Document ) -> DbResult<UpdateResult>
Updates all documents matching query
in the collection.
documentation for more information on specifying updates.
sourcepub fn update_many_with_session(
&self,
query: Document,
update: Document,
session: &mut ClientSession
) -> DbResult<UpdateResult>
pub fn update_many_with_session( &self, query: Document, update: Document, session: &mut ClientSession ) -> DbResult<UpdateResult>
Updates all documents matching query
in the collection.
documentation for more information on specifying updates.
sourcepub fn delete_one(&self, query: Document) -> DbResult<DeleteResult>
pub fn delete_one(&self, query: Document) -> DbResult<DeleteResult>
Deletes up to one document found matching query
.
sourcepub fn delete_one_with_session(
&self,
query: Document,
session: &mut ClientSession
) -> DbResult<DeleteResult>
pub fn delete_one_with_session( &self, query: Document, session: &mut ClientSession ) -> DbResult<DeleteResult>
Deletes up to one document found matching query
.
sourcepub fn delete_many(&self, query: Document) -> DbResult<DeleteResult>
pub fn delete_many(&self, query: Document) -> DbResult<DeleteResult>
When query is None
, all the data in the collection will be deleted.
The size of data deleted returns.
sourcepub fn delete_many_with_session(
&self,
query: Document,
session: &mut ClientSession
) -> DbResult<DeleteResult>
pub fn delete_many_with_session( &self, query: Document, session: &mut ClientSession ) -> DbResult<DeleteResult>
When query is None
, all the data in the collection will be deleted.
The size of data deleted returns.
pub fn drop(&self) -> DbResult<()>
pub fn drop_with_session(&self, session: &mut ClientSession) -> DbResult<()>
source§impl<T> Collection<T>where
T: Serialize,
impl<T> Collection<T>where T: Serialize,
sourcepub fn insert_one(&self, doc: impl Borrow<T>) -> DbResult<InsertOneResult>
pub fn insert_one(&self, doc: impl Borrow<T>) -> DbResult<InsertOneResult>
Inserts doc
into the collection.
sourcepub fn insert_one_with_session(
&self,
doc: impl Borrow<T>,
session: &mut ClientSession
) -> DbResult<InsertOneResult>
pub fn insert_one_with_session( &self, doc: impl Borrow<T>, session: &mut ClientSession ) -> DbResult<InsertOneResult>
Inserts doc
into the collection.
sourcepub fn insert_many(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>
) -> DbResult<InsertManyResult>
pub fn insert_many( &self, docs: impl IntoIterator<Item = impl Borrow<T>> ) -> DbResult<InsertManyResult>
Inserts the data in docs
into the collection.
sourcepub fn insert_many_with_session(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>,
session: &mut ClientSession
) -> DbResult<InsertManyResult>
pub fn insert_many_with_session( &self, docs: impl IntoIterator<Item = impl Borrow<T>>, session: &mut ClientSession ) -> DbResult<InsertManyResult>
Inserts the data in docs
into the collection.
source§impl<T> Collection<T>where
T: DeserializeOwned,
impl<T> Collection<T>where T: DeserializeOwned,
sourcepub fn find(
&self,
filter: impl Into<Option<Document>>
) -> DbResult<ClientCursor<T>>
pub fn find( &self, filter: impl Into<Option<Document>> ) -> DbResult<ClientCursor<T>>
When query document is passed to the function. The result satisfies the query document.
sourcepub fn find_with_session(
&self,
filter: impl Into<Option<Document>>,
session: &mut ClientSession
) -> DbResult<ClientSessionCursor<T>>
pub fn find_with_session( &self, filter: impl Into<Option<Document>>, session: &mut ClientSession ) -> DbResult<ClientSessionCursor<T>>
When query document is passed to the function. The result satisfies the query document.
Auto Trait Implementations§
impl<T> RefUnwindSafe for Collection<T>where T: RefUnwindSafe,
impl<T> Send for Collection<T>where T: Send,
impl<T> Sync for Collection<T>where T: Sync,
impl<T> Unpin for Collection<T>where T: Unpin,
impl<T> UnwindSafe for Collection<T>where T: UnwindSafe,
Blanket Implementations§
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.