Skip to main content

Collection

Struct Collection 

Source
pub struct Collection<T> { /* private fields */ }
Expand description

Typed handle for records in a collection.

Implementations§

Source§

impl<T> Collection<T>

Source

pub fn new(store: Store, name: CollectionName) -> Self

Creates a collection handle.

Source

pub fn name(&self) -> &CollectionName

Returns the collection name.

Source

pub async fn get<K>(&self, key: K) -> Result<Option<T>>

Reads a typed value.

Source

pub async fn set<K>(&self, key: K, value: &T) -> Result<()>

Writes a typed value.

Source

pub async fn delete<K>(&self, key: K) -> Result<bool>
where K: TryInto<Key>, YugenDbError: From<K::Error>,

Deletes a value.

Source

pub async fn exists<K>(&self, key: K) -> Result<bool>
where K: TryInto<Key>, YugenDbError: From<K::Error>,

Returns whether a key exists.

Source

pub async fn scan_prefix( &self, prefix: impl Into<String>, ) -> Result<Vec<(Key, T)>>

Scans typed values by key prefix.

Trait Implementations§

Source§

impl<T: Clone> Clone for Collection<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Collection<T>

§

impl<T> !UnwindSafe for Collection<T>

§

impl<T> Freeze for Collection<T>

§

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> UnsafeUnpin for Collection<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.