Struct bonsaidb::core::connection::Collection

source · [−]

pub struct Collection<'a, Cn, Cl> { /* private fields */ }

Expand description

Interacts with a collection over a Connection.

Implementations

source

impl<'a, Cn, Cl> Collection<'a, Cn, Cl> where
Cn: Connection,
Cl: Collection,

source

pub fn new(connection: &'a Cn) -> Collection<'a, Cn, Cl>

Creates a new instance using connection.

source

pub async fn push(
    &'_ self,
    item: &'_ <Cl as SerializedCollection>::Contents
) -> Result<Header, Error> where
    Cl: SerializedCollection,

Adds a new Document<Cl> with the contents item.

source

pub async fn push_bytes<B>(&'_ self, contents: B) -> Result<Header, Error> where
B: Into<Bytes> + Send,
Cl: SerializedCollection,

Adds a new Document<Cl> with the contents.

source

pub async fn insert(
    &'_ self,
    id: u64,
    item: &'_ <Cl as SerializedCollection>::Contents
) -> Result<Header, Error> where
    Cl: SerializedCollection,

Adds a new Document<Cl> with the given id and contents item.

source

pub async fn insert_bytes<B>(
    &'_ self,
    id: u64,
    contents: B
) -> Result<Header, Error> where
    B: Into<Bytes> + Send,
    Cl: SerializedCollection,

Adds a new Document<Cl> with the the given id and contents.

source

pub async fn get(&'_ self, id: u64) -> Result<Option<OwnedDocument>, Error>

Retrieves a Document<Cl> with id from the connection.

source

pub async fn get_multiple(
&'_ self,
ids: &'_ [u64 ]
) -> Result<Vec<OwnedDocument, Global>, Error>

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

source

pub fn list<R>(&'a self, ids: R) -> List<'a, Cn, Cl>ⓘ
Notable traits for List<'a, Cn, Cl>
`impl<'a, Cn, Cl> Future for List<'a, Cn, Cl> where Cn: Connection, Cl: Collection + Unpin, type Output = Result<Vec<OwnedDocument, Global>, Error>;`
where
R: Into<Range<u64>>,

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

source

pub async fn delete<H>(&'_ self, doc: &'_ H) -> Result<(), Error> where
H: AsRef<Header> + Send + Sync,

Removes a Document from the database.

Trait Implementations

source

impl<'a, Cn, Cl> Clone for Collection<'a, Cn, Cl>

source

pub fn clone(&self) -> Collection<'a, Cn, Cl>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl<'a, Cn, Cl> RefUnwindSafe for Collection<'a, Cn, Cl> where
Cl: RefUnwindSafe,
Cn: RefUnwindSafe,

impl<'a, Cn, Cl> Send for Collection<'a, Cn, Cl> where
Cl: Send,
Cn: Sync,

impl<'a, Cn, Cl> Sync for Collection<'a, Cn, Cl> where
Cl: Sync,
Cn: Sync,

impl<'a, Cn, Cl> Unpin for Collection<'a, Cn, Cl> where
Cl: Unpin,

impl<'a, Cn, Cl> UnwindSafe for Collection<'a, Cn, Cl> where
Cl: UnwindSafe,
Cn: RefUnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub 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>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bonsaidb::core::connection::Collection

Implementations

impl<'a, Cn, Cl> Collection<'a, Cn, Cl> where Cn: Connection, Cl: Collection,

pub fn new(connection: &'a Cn) -> Collection<'a, Cn, Cl>

pub async fn push( &'_ self, item: &'_ <Cl as SerializedCollection>::Contents) -> Result<Header, Error> where Cl: SerializedCollection,

pub async fn push_bytes<B>(&'_ self, contents: B) -> Result<Header, Error> where B: Into<Bytes> + Send, Cl: SerializedCollection,

pub async fn insert( &'_ self, id: u64, item: &'_ <Cl as SerializedCollection>::Contents) -> Result<Header, Error> where Cl: SerializedCollection,

pub async fn insert_bytes<B>( &'_ self, id: u64, contents: B) -> Result<Header, Error> where B: Into<Bytes> + Send, Cl: SerializedCollection,

pub async fn get(&'_ self, id: u64) -> Result<Option<OwnedDocument>, Error>

pub async fn get_multiple( &'_ self, ids: &'_ [u64]) -> Result<Vec<OwnedDocument, Global>, Error>

pub fn list<R>(&'a self, ids: R) -> List<'a, Cn, Cl>ⓘNotable traits for List<'a, Cn, Cl>impl<'a, Cn, Cl> Future for List<'a, Cn, Cl> where Cn: Connection, Cl: Collection + Unpin, type Output = Result<Vec<OwnedDocument, Global>, Error>; where R: Into<Range<u64>>,

pub async fn delete<H>(&'_ self, doc: &'_ H) -> Result<(), Error> where H: AsRef<Header> + Send + Sync,

Trait Implementations

impl<'a, Cn, Cl> Clone for Collection<'a, Cn, Cl>

pub fn clone(&self) -> Collection<'a, Cn, Cl>

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

Auto Trait Implementations

impl<'a, Cn, Cl> RefUnwindSafe for Collection<'a, Cn, Cl> where Cl: RefUnwindSafe, Cn: RefUnwindSafe,

impl<'a, Cn, Cl> Send for Collection<'a, Cn, Cl> where Cl: Send, Cn: Sync,

impl<'a, Cn, Cl> Sync for Collection<'a, Cn, Cl> where Cl: Sync, Cn: Sync,

impl<'a, Cn, Cl> Unpin for Collection<'a, Cn, Cl> where Cl: Unpin,

impl<'a, Cn, Cl> UnwindSafe for Collection<'a, Cn, Cl> where Cl: UnwindSafe, Cn: RefUnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<'a, Cn, Cl> Collection<'a, Cn, Cl> where
Cn: Connection,
Cl: Collection,

pub async fn push(
&'_ self,
item: &'_ <Cl as SerializedCollection>::Contents
) -> Result<Header, Error> where
Cl: SerializedCollection,

pub async fn push_bytes<B>(&'_ self, contents: B) -> Result<Header, Error> where
B: Into<Bytes> + Send,
Cl: SerializedCollection,

pub async fn insert(
&'_ self,
id: u64,
item: &'_ <Cl as SerializedCollection>::Contents
) -> Result<Header, Error> where
Cl: SerializedCollection,

pub async fn insert_bytes<B>(
&'_ self,
id: u64,
contents: B
) -> Result<Header, Error> where
B: Into<Bytes> + Send,
Cl: SerializedCollection,

pub async fn get_multiple(
&'_ self,
ids: &'_ [u64 ]
) -> Result<Vec<OwnedDocument, Global>, Error>

pub fn list<R>(&'a self, ids: R) -> List<'a, Cn, Cl>ⓘ
Notable traits for List<'a, Cn, Cl>
`impl<'a, Cn, Cl> Future for List<'a, Cn, Cl> where Cn: Connection, Cl: Collection + Unpin, type Output = Result<Vec<OwnedDocument, Global>, Error>;`
where
R: Into<Range<u64>>,

pub async fn delete<H>(&'_ self, doc: &'_ H) -> Result<(), Error> where
H: AsRef<Header> + Send + Sync,

impl<'a, Cn, Cl> RefUnwindSafe for Collection<'a, Cn, Cl> where
Cl: RefUnwindSafe,
Cn: RefUnwindSafe,

impl<'a, Cn, Cl> Send for Collection<'a, Cn, Cl> where
Cl: Send,
Cn: Sync,

impl<'a, Cn, Cl> Sync for Collection<'a, Cn, Cl> where
Cl: Sync,
Cn: Sync,

impl<'a, Cn, Cl> Unpin for Collection<'a, Cn, Cl> where
Cl: Unpin,

impl<'a, Cn, Cl> UnwindSafe for Collection<'a, Cn, Cl> where
Cl: UnwindSafe,
Cn: RefUnwindSafe,

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,