Enum bonsaidb::core::schema::NamedReference

pub enum NamedReference<'a, Id> {
    Name(Cow<'a, str>),
    Id(DocumentId),
    Key(Id),
}

A reference to a collection that has a unique name view.

Variants

Name(Cow<'a, str>)

Tuple Fields

0: Cow<'a, str>

An entity’s name.

Id(DocumentId)

Tuple Fields

0: DocumentId

A document id.

Key(Id)

Tuple Fields

0: Id

A document id.

Implementations

impl<'a, Id> NamedReference<'a, Id> where
    Id: for<'k> Key<'k>, 

pub fn into_owned(self) -> NamedReference<'static, Id>

Converts this reference to an owned reference with a 'static lifetime.

pub fn id<Col, Cn>(
    &self,
    connection: &Cn
) -> Result<Option<<Col as Collection>::PrimaryKey>, Error> where
    Col: NamedCollection<PrimaryKey = Id>,
    Cn: Connection, 

Returns this reference’s id. If the reference is a name, the NamedCollection::ByNameView is queried for the id.

pub async fn id_async<Col, Cn>(
    &'_ self,
    connection: &'_ Cn
) -> Result<Option<<Col as Collection>::PrimaryKey>, Error> where
    Col: NamedCollection<PrimaryKey = Id>,
    Cn: AsyncConnection, 

Returns this reference’s id. If the reference is a name, the NamedCollection::ByNameView is queried for the id.

Trait Implementations

impl<'a, Id> Clone for NamedReference<'a, Id> where
    Id: Clone, 

pub fn clone(&self) -> NamedReference<'a, Id>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Id> Debug for NamedReference<'a, Id> where
    Id: Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de, 'a, Id> Deserialize<'de> for NamedReference<'a, Id> where
    Id: Deserialize<'de>, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<NamedReference<'a, Id>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a, Id> From<&'a String> for NamedReference<'a, Id>

pub fn from(name: &'a String) -> NamedReference<'a, Id>

Performs the conversion.

impl<'a, Id> From<&'a str> for NamedReference<'a, Id>

pub fn from(name: &'a str) -> NamedReference<'a, Id>

Performs the conversion.

impl<'a, 'b, 'c, Id> From<&'b BorrowedDocument<'b>> for NamedReference<'a, Id>

pub fn from(doc: &'b BorrowedDocument<'b>) -> NamedReference<'a, Id>

Performs the conversion.

impl<'a, Id> From<DocumentId> for NamedReference<'a, Id>

pub fn from(id: DocumentId) -> NamedReference<'a, Id>

Performs the conversion.

impl<'a, Id> From<String> for NamedReference<'a, Id>

pub fn from(name: String) -> NamedReference<'a, Id>

Performs the conversion.

impl<'a, Id> Nameable<'a, Id> for NamedReference<'a, Id>

pub fn name(self) -> Result<NamedReference<'a, Id>, Error>

Returns this name as a NamedReference.

impl<'a, Id> PartialEq<NamedReference<'a, Id>> for NamedReference<'a, Id> where
    Id: PartialEq<Id>, 

pub fn eq(&self, other: &NamedReference<'a, Id>) -> bool

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

pub fn ne(&self, other: &NamedReference<'a, Id>) -> bool

This method tests for !=.

impl<'a, Id> Serialize for NamedReference<'a, Id> where
    Id: Serialize, 

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a, 'c, C> TryFrom<&'c CollectionDocument<C>> for NamedReference<'a, <C as Collection>::PrimaryKey> where
    C: SerializedCollection, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(
    doc: &'c CollectionDocument<C>
) -> Result<NamedReference<'a, <C as Collection>::PrimaryKey>, Error>

Performs the conversion.

impl<'a, Id> StructuralPartialEq for NamedReference<'a, Id>